docs: add `CONTRIBUTING.MD`

main
olimorris 2023-11-18 19:44:49 +00:00
parent 3ebc5d77ae
commit d821524f94
1 changed files with 10 additions and 0 deletions

10
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,10 @@
# Contributing
If you open a PR please consider the following:
- If you're adding new functionality, please open an issue to discuss the design of the new feature
- How the end user will consume your new feature. It's often easier to start with the API and work backwards
- Consider the use of [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to make your commit messages more descriptive
- Add new tests to the plugin (use the existing ones as a template)
The mantra for this plugin is "simple session management" and as such the code base is relatively simple. Please consider this in your code.