- Fork the repository to your own account.
- Clone it to your local machine using
$ git clone https://github.com/YOUR_ACCOUNT/devbox.git
- Create a branch for local development
$ git checkout -b name-of-your-feature
-
Make the required changes:
- It's important to use to keep high standard of code, so please develop using TDD:
- Write a failing test first - Write a minimum amount of code to satisfy the failing test - Refactor the code
- Running tests from command line:
$ python setup.py test
-
Commit and push them to github
$ git add .
$ git commit -m "Your detailed description of your changes"
$ git push origin name-of-your-feature
- Submit a pull request
Before you submit a pull request, make sure it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in [Usage](usage.md]
- The pull request should support for Python 2.7. Check https://travis-ci.org/QualiSystems/devbox and make sure that the tests pass for all supported Python versions.
Return to Table of Contents