Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.08 KB

Author: Coty Sutherland, Alex Meadows

How to contribute

Want to participate/contribute to etlTest? Feel free to add any enhancements, feature requests, etc.

Getting Started

  • Create a new, Python 2.7+ virtualenv and install the requirements via pip:

      $ pip install -r requirements.txt
    
  • Make sure you have a GitHub account

  • Submit issues/suggestions to the Github issue tracker

    • For bugs, clearly describe the issue including steps to reproduce
    • For enhancement requests, be sure to indicate if you are willing to work on implementing the enhancement
      • Fork the repository on GitHub if you want to contribute code/docs

Making Changes

  • <> uses git-flow as the git branching model

    • All commits should be made to the develop branch

    • Install git-flow and create a feature branch with the following command:

          $ git flow feature start <name of your feature>
      
  • Make commits of logical units with complete documentation.

  • Check for unnecessary whitespace with git diff --check before committing.

  • Make sure you have added the necessary tests for your changes.

    • Test coverage is currently tracked via coveralls.io
    • Aim for 100% coverage on your code
      • If this is not possible, explain why in your commit message. This may be an indication that your code should be refactored.
  • Run python setup.py test to make sure your tests pass

  • Run coverage run --source=etltest setup.py test if you have the coverage package installed to generate coverage data

  • Check your coverage by running coverage report

Submitting Changes

  • Push your changes to the feature branch in your fork of the repository.
  • Submit a pull request to the main repository

Additional Resources