You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Contributing to react-mindee-js
1
+
# Contributing to mindee-api-python
2
2
3
3
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4
4
5
-
The following is a set of guidelines for contributing to react-mindee-js which are hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
5
+
The following is a set of guidelines for contributing to mindee-api-python which are hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6
6
7
7
## Code of Conduct
8
8
@@ -28,7 +28,7 @@ To help maintainers and the community to be efficient, follow these guidelines:
28
28
29
29
Include details about your configuration and environment:
30
30
31
-
***Which version of react-mindee-js are you using?**
31
+
***Which version of mindee-api-python are you using?**
32
32
***What's the name and version of the browser you're using, on which OS**?
33
33
34
34
### Suggesting Enhancements
@@ -42,7 +42,7 @@ Make sure to provide the following information:
42
42
***Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
43
43
***Describe the current behavior** and **explain which behavior you expected to see instead** and why.
44
44
***Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of the sdk which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
45
-
***Specify which version of react-mindee-js you're using.**
45
+
***Specify which version of mindee-api-python you're using.**
46
46
***Specify the name and version of the browser and OS you're using.**
47
47
48
48
### Pull Requests
@@ -78,7 +78,6 @@ Example:
78
78
* new: :sparkles: Add CONTRIBUTING file in repository
79
79
* fix: :bug: MyComponent - Prevent MouseEvent from firing unexpectedly
80
80
81
-
### JavaScript Styleguide
81
+
### Python Styleguide
82
82
83
-
We keep our code base consistent and we expect React/JavaScript code to must adhere to [JavaScript Standard Style](https://standardjs.com/).
84
-
When possible, adding [flow](https://flow.org/) types is also expected.
83
+
We keep our code base consistent and we expect Python code to adhere to the [Black Code Style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html).
0 commit comments