Awesome! Here are instructions to get you started. They are probably not perfect, please let us know if anything feels wrong or incomplete.
In general, we follow the "fork-and-pull" Git workflow.
- Fork this repo
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve.
Submit unit tests for your changes. Python has a great test framework built in; use it! Take a look at existing tests for inspiration. Run the full test suite on your branch before submitting a pull request.
Make sure you include relevant updates or additions to documentation when creating or modifying features.