🎉 Thanks, for considering to contribute to PINEKO!
🙏 For the sake of simplicity we switch below to imperative language, however, please read a "Please" in front of everything.
- 🧠 Be reasonable and use common sense when contributing: we added some points we would like to highlight below
- 👪 Follow our Code of Conduct and use the provided Issue Templates
- ✉️
poetryis the dependency manager and packaging back-end of choice for this project - see the official installation guide - #️⃣
poery-dynamic-versioning, is used to update the package version based on VCS status (tags and commits); note that since the version is dumped in output object, this is to be used not only for releases, but whenever output is generated (and intended to be used) 🅿️ pre-commitis used to enforce automation and standardize the tools for all developers; if you want to contribute to this project, install it and setup
- 🐘 Make sure to not break the old tests (unless there was a mistake)
- 🐣 Write new tests for your new code - the coverage should be back to 100% if possible
- 🎨 Run black to style your code
- 📘 Use numpy documentation guide
Make sure the commit message is written properly (This
blogpost explains it
nicely)