If you want to develop a new feature or fix a bug, here are the steps.
- Clone the repository
git clone [email protected]:nbro/andz.git - Checkout
masterwithgit checkout master - Make sure it's up-to-date:
git pull - Create the feature branch:
git checkout -b <local-branch-name> - Make the changes that you want
- Run the checks and tests:
make check test - Add your changes e.g. with
git add -uorgit add . - Commit your changes with a commit message that starts with a verb (e.g.
git commit -m "Update the README") - Push your changes to the remote:
git push --set-upstream origin <remote-branch-name> - Make a pull request (PR)
- Ask for code review (if there's another developer)
- Once the PR is approved, merge your feature branch into
master
To run all tests, you can do
make test
To run all the tests under e.g. tests/algorithms/sorting/integer, use
poetry run coverage run --source=. -m unittest discover -s tests/algorithms/sorting/integer -v
Or run a specific test
poetry run coverage run --source=. -m unittest tests/ds/test_MinMaxHeap.py -v
See the
Makefilefor more info about other commands.