Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.18 KB

Contributing

Setting up a development environment

Use Poetry to install dependencies and create the virtual environment:

poetry install

Running Tests

poetry shell
python -m flake8
python -m coverage run -m unittest discover
python -m coverage report

coverage xml && coverage html are configured to output reports in the build directory.

Test Coverage

To contribute to makeflatt, please make sure that any new features or changes to existing functionality include test coverage.

Pull requests that add or change code without coverage have a much lower chance of being accepted.

Pull requests that fail flake8 tests as configured will not be accepted.

Code Formatting

Please format your code using yapf with pep8 style prior to issuing your pull request.

Versioning

makeflatt subscribes to semver style versioning.

Given a version number MAJOR.MINOR.PATCH increment the:

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards-compatible manner, and
  • PATCH version when you make backwards-compatible bug fixes.