Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 911 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 911 Bytes
Raw

Contributing

Add features or fix bugs

  • Fork the repo
  • Check out a feature or bug branch
  • Add your changes
  • Update README when needed
  • Submit a pull request to upstream repo
  • Add description of your changes
  • Ensure tests are passing
  • Ensure branch is mergeable

Test

Testing is set up using pytest and coverage is handled with the pytest-cov plugin.

Run your tests with py.test in the root directory and please make sure all tests pass.

Coverage is ran by default and is set in the pytest.ini file. To see an html output of coverage open htmlcov/index.html after running the tests.

Release

Install Twine:

pip install twine

Create distributions:

python setup.py sdist bdist_wheel

Upload to TestPyPI/PyPI:

# Test PyPi
twine upload -r testpypi dist/*
# PyPi
twine upload dist/*