Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.29 KB

contributing.md

File metadata and controls

45 lines (34 loc) · 1.29 KB

Contributing

  • 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:

    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

Pull Request Guidelines

Before you submit a pull request, make sure it meets these guidelines:

  1. The pull request should include tests.
  2. 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]
  3. 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