How to Contribute

🎉 Thanks, for considering to contribute to yadism!

🙏 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
🔢 Use the almost standard SemVer for version numbers

Tools

✉️ poetry is 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-commit is used to enforce automation and standardize the tools for all developers; if you want to contribute to this project, install it and activate it

Docs

📚 in order to run the notebooks in the environment, you need first to install the environment kernel:
```
poe docs-install-nb
```
thanks to Nikolai Janakiev

Testing

🐘 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

Style Conventions

Python Styleguide

📘 Use numpy documentation guide

Git

Make sure the commit message is written properly (This blogpost explains it nicely)