docs: add contributing guideline

docs: add issue and PR templates
This commit is contained in:
Félix Voituret
2019-11-04 13:56:24 +01:00
parent 4b97bd795f
commit 73ed21391a
3 changed files with 55 additions and 0 deletions

9
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,9 @@
# How-to contribute
Those are the main contributing guidelines for contributing to this project:
- Verify that your contribution does not embark proprietary code or infringe any copyright of any sort.
- Avoid adding any unnecessary dependencies to the project, espcially of those are not easily packaged and installed through `conda` or `pip`.
- Python contributions must follow the [PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/).
- Use [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) mechanism and please be patient while waiting for reviews.
- Remain polite and civil in all exchanges with the maintainers and other contributors.