WaniKani CLI welcomes contributions from the community.
- On github interface click on Fork button.
- Clone your fork of this repo.
git clone git@github.com:YOUR_GIT_USERNAME/hebikani.git
- Enter the directory
cd hebikani
- Add upstream repo
git remote add upstream https://github.com/ajite/hebikani
poetry install
already takes care of this for you. You can use poetry shell
to activate it.
Try to write a test for your new feature.
poetry run pytest
poetry run black
poetry run flake8
This project uses conventional git commit messages.
Example:
fix: questions were appearing twice during review session
Due to a typo issue in the session while loop...
......................
......................
Run git push origin my_contribution
On github interface, click on Pull Request button.
Wait CI to run and one of the developers will review your PR.