From d821524f94b576474234d17e68c3751b36ae188b Mon Sep 17 00:00:00 2001 From: olimorris Date: Sat, 18 Nov 2023 19:44:49 +0000 Subject: [PATCH] docs: add `CONTRIBUTING.MD` --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6e8d6d0 --- /dev/null +++ b/CONTRIBUTING.md @@ -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.