Skip to content

Commit

Permalink
Add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
mottosso committed May 23, 2016
1 parent 9901625 commit 7a9d40a
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 7a9d40a

Please sign in to comment.