Use of virtual environments will allow for isolated installation of testing requirements:
./bootstrap
source env/bin/activate
flake8
coverage run && coverage report
coverage xml
&& coverage html
are configured to output reports in the build
directory.
To contribute to flatdict
, 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.
Please format your code using yapf
with pep8
style prior to issuing your pull request.
flatdict 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, andPATCH
version when you make backwards-compatible bug fixes.