development-guide.md

Development Guide

Running the code

$ python3 -m shallow_backup

Testing

$ pipenv shell
$ pipenv install
$ pytest

####
# Code Coverage
# NOTE: This makes some tests fail -- not sure why. Just ignore those for now.
####

$ py.test --cov --cov-report html:code_coverage 
$ open code_coverage/index.html

Make sure all existing tests pass before opening a PR! Also, add any necessary tests for new code.

Deployment

Run scripts/release.sh from the project root.

Code Style

You should follow the code style already established in the code base.

PEP8 is generally to be followed, but I think that prettier code to look at in an editor is more important that strictly following PEP8.

All files should end with a new line.

PRs with changes in indentation style will not be merged. Tabs (width of 4 spaces) should be used.

Continuous Integration Testing and Static Analysis

• Travis CI
• Codacy
• CodeClimate
• Coveralls