Skip to content

Commit 5fccd0f

Browse files
ianardeeixunio
authored andcommitted
chg: 📝 update docs with correct CI and style info
1 parent 4ad8b80 commit 5fccd0f

File tree

5 files changed

+10
-12
lines changed

5 files changed

+10
-12
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
126126

127127
For answers to common questions about this code of conduct, see the FAQ at
128128
https://www.contributor-covenant.org/faq. Translations are available at
129-
https://www.contributor-covenant.org/translations.
129+
https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Contributing to react-mindee-js
1+
# Contributing to mindee-api-python
22

33
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
44

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.
66

77
## Code of Conduct
88

@@ -28,7 +28,7 @@ To help maintainers and the community to be efficient, follow these guidelines:
2828
2929
Include details about your configuration and environment:
3030

31-
* **Which version of react-mindee-js are you using?**
31+
* **Which version of mindee-api-python are you using?**
3232
* **What's the name and version of the browser you're using, on which OS**?
3333

3434
### Suggesting Enhancements
@@ -42,7 +42,7 @@ Make sure to provide the following information:
4242
* **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).
4343
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
4444
* **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.**
4646
* **Specify the name and version of the browser and OS you're using.**
4747

4848
### Pull Requests
@@ -78,7 +78,6 @@ Example:
7878
* new: :sparkles: Add CONTRIBUTING file in repository
7979
* fix: :bug: MyComponent - Prevent MouseEvent from firing unexpectedly
8080

81-
### JavaScript Styleguide
81+
### Python Styleguide
8282

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).

ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ Also, please include the browser, OS and what version you're running. -->
4242

4343
### Additional Information
4444

45-
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. -->
45+
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. -->

PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,4 @@
4141
- [ ] I have updated the documentation accordingly.
4242
- [ ] I have read the **CONTRIBUTING** document.
4343
- [ ] I have added tests to cover my changes.
44-
- [ ] I have added type hints (flow) to cover my changes.
45-
- [ ] All new and existing tests passed.
44+
- [ ] All new and existing tests passed.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The full documentation is available [here](https://developers.mindee.com/docs/ge
44

55
## Requirements
66

7-
This library is compatible with Python 3.5 and above.
7+
This library is officially supported on Python 3.6 to 3.9.
88

99
## Install
1010

0 commit comments

Comments
 (0)