-
Fork this repository.
-
git clone {your fork's url}
-
cd {dogey directory}
-
git switch pre-release
to first put the PRs in a testing phase. -
pip install -e .
Optional but speeds up changes (modifies the Dogey package everytime it's updated locally) -
Change anything you want, which makes sense.
-
Docstrings in each and every new method/variable (only in api.py, Dogey.init)
-
Explain your code, at times, and your target in small comments.
-
Test everything you have added.
-
If everything works, type
git push
-
Go to your forked repository and click on Pull Request.
-
Add a descriptive title and description.
-
Wait for your PR to be reviewed(may be closed/modified to fit Dogey's coding style).
-
Create examples and, with the prementioned guide, push them to this repository.
-
Suggest ideas in the Issues tab.