mirror of
https://github.com/vale981/clay
synced 2025-03-05 09:31:40 -05:00
52 lines
1.3 KiB
ReStructuredText
52 lines
1.3 KiB
ReStructuredText
How to contribute to Clay
|
|
======
|
|
|
|
Bugs
|
|
####
|
|
|
|
Reporting bugs
|
|
****
|
|
- Please read the `README`_ carefully.
|
|
- Search our `Github issues`_
|
|
to see whether it already has been reported.
|
|
- Follow the relevant template.
|
|
|
|
Feature request
|
|
****
|
|
Feature requests are always welcome but do keep in mind that it might
|
|
take a very long time (or maybe forever!) until we get to it.
|
|
|
|
Did you write a patch that fixes a bug?
|
|
****
|
|
- File a relevant issue if one doesn't already exist
|
|
- Open a new pull request with the patch
|
|
- Ensure the PR description describes the problem
|
|
- Follow the code guidelines
|
|
|
|
Any questions
|
|
****
|
|
Feel free to ask any questions on our irc channel:
|
|
|
|
- Server: irc.oftc.net
|
|
- Channel: **#clay**
|
|
|
|
Code guidelines
|
|
####
|
|
|
|
Python guidelines
|
|
****
|
|
- Please follow `PEP 8`_
|
|
- Write docstrings using the `Google Style Docstrings`_
|
|
- Bare exceptions should be avoided
|
|
|
|
Git guidelines
|
|
****
|
|
- Make sure that every commit functions an standalone unit.
|
|
- Commit messages need to be descriptive
|
|
- Pull requests that only change cosmetics will probably be denied.
|
|
- Run a linter before commiting
|
|
|
|
.. _README: README.md
|
|
.. _Github issues: https://github.com/and3rson/Clay/issues
|
|
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
|
|
.. _Google Style Docstrings: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
|