Please follow these steps to get your work merged in.
- Read the design guidelines in the
docs/
folder. - Clone the repo and make a new branch:
$ git checkout https://github.com/alichtman/shallow-backup -b [name_of_new_branch]
. - Add a feature, fix a bug, or refactor some code :)
- Write/update tests for the changes you made, if necessary.
- Run unit tests and make sure all tests pass:
python3 -m pytest
. - Update
README.md
andCONTRIBUTORS.md
, if necessary. - Open a Pull Request with a comprehensive description of changes.