Skip to content

Add contribution guide. #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dr-ZeeD wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add contribution guide. #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
============
Contributing
============

Developing
==========

1. Fork the repo on GitHub.
2. Clone your fork locally.
3. Install your local copy into a virtual environment.
4. Create a branch for local development. Use the naming convention
`feature/{{name-of-feature}}` for features and `bugfix/{{name-of-bug}}` for
bugfixes.
5. Implement the feature/bugfix. Write tests that prove your implementation
works as intended.
6. Once your feature is implemented run the complete test suite using `tox`.
7. Push the changes to your GitHub repository.
8. Submit a pull request to the original repository using the GitHub website.


Pull Request Guidelines
=======================

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated.
3. Make sure the complete test suite passes. Use `tox` to verify it on your
local machine.