-
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Julien <dev@ingeoveritas.com>
- Loading branch information
Showing
52 changed files
with
11,470 additions
and
417 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| First off, thanks for considering to contribute to this project! | ||
|
|
||
| These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
|
||
| ## Git hooks | ||
|
|
||
| We use git hooks through [pre-commit](https://pre-commit.com/) to enforce and automatically check some "rules". Please install it before to push any commit. | ||
|
|
||
| See the relevant configuration file: `.pre-commit-config.yaml`. | ||
|
|
||
| ## Code Style | ||
|
|
||
| Make sure your code *roughly* follows [PEP-8](https://www.python.org/dev/peps/pep-0008/) and keeps things consistent with the rest of the code: | ||
|
|
||
| - docstrings: [sphinx-style](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format) is used to write technical documentation. | ||
| - formatting: [black](https://black.readthedocs.io/) is used to automatically format the code without debate. | ||
| - sorted imports: [isort](https://pycqa.github.io/isort/) is used to sort imports | ||
| - static analysis: [flake8](https://flake8.pycqa.org/en/latest/) is used to catch some dizziness and keep the source code healthy. | ||
|
|
||
| ---- | ||
|
|
||
| ## IDE | ||
|
|
||
| Feel free to use the IDE you love. Here come configurations for some popular IDEs to fit those guidelines. | ||
|
|
||
| ### Visual Studio Code | ||
|
|
||
| ```jsonc | ||
| { | ||
| "python.defaultInterpreterPath": ".venv/bin/python", | ||
| // 👆 For Windows, change it to "./.venv/Scripts/python.exe". | ||
| // Or you can manually select one when VS Code asks for it. | ||
| // Editor | ||
| "editor.bracketPairColorization.enabled": true, | ||
| "editor.guides.bracketPairs":"active", | ||
| "editor.rulers": [ | ||
| 88 | ||
| ], | ||
| "editor.wordWrapColumn": 88, | ||
| "files.associations": { | ||
| "./requirements/*.txt": "pip-requirements" | ||
| }, | ||
| // Formatter | ||
| "python.formatting.provider": "black", | ||
| "python.formatting.blackArgs": [ | ||
| "--target-version=py38" | ||
| ], | ||
| // Linter | ||
| "python.linting.enabled": true, | ||
| "python.linting.flake8Enabled": true, | ||
| "python.linting.flake8Args": [ | ||
| "--config=setup.cfg", | ||
| "--verbose" | ||
| ], | ||
| "python.linting.pylintEnabled": false, | ||
| // Tests | ||
| "python.testing.pytestArgs": [], | ||
| "python.testing.unittestEnabled": false, | ||
| "python.testing.pytestEnabled": true, | ||
| // Git | ||
| "git.enableCommitSigning": true, | ||
| // Extensions | ||
| "autoDocstring.docstringFormat": "sphinx", | ||
| "yaml.schemas": { | ||
| "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs*.yml" | ||
| } | ||
| } | ||
| ``` | ||
| Contributing guidelines are now published on [the online documentation](https://guts.github.io/mkdocs-rss-plugin/contributing/). |
Oops, something went wrong.