diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e1e7949 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +### Contributing To Pyblish Lite + +If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request. + +When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Pyblish follows [PEP8](https://www.python.org/dev/peps/pep-0008/) and the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html). Docstrings are written in the [Google Napoleon format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). + +#### Reporting Bugs + +If you report a bug, please ensure to specify the following: + +- Description +- Expected Results +- Minimal steps to reproduce + +#### Requesting or Proposing Features + +When specifying a feature, try to format it such that anyone can implement it without necessarily asking you about it. + +Include the following: + +- Goal +- Motivation +- Implementation