diff options
| author | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2023-09-15 18:08:03 +0200 |
|---|---|---|
| committer | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2023-09-15 18:08:03 +0200 |
| commit | 650c5f155e98dc8428ab617a535541736c9dd08f (patch) | |
| tree | 0359a462d144216e0d849bc29767cea39b1bc1c5 | |
| parent | 65b2c3feb11adffaccf2a5c49f60f738c146d910 (diff) | |
Add a contributing guide
| -rw-r--r-- | CONTRIBUTING.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c70db5a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to Junction + +At this moment Junction is more of a hobby project and we want to keep the +scope and feature set small, however bugfixes and improvements are appreciated! + +## Types of contribution that are welcome + +- Bugfixes +- Reliability improvements +- Tests +- Tooling improvements + +For other type of contributions, such as new features, please make proposals +in the [junction-devel][junction-devel] mailing list first. + +## How to contribute + +Above All: Be nice, always. + +Before submitting a patch, make sure: + +- You run `make format` before submitting. +- Make sure you test the work. + +## How to send patches + +Send the patch to the [junction-deve][junction-devel] mailing list. See +[git-send-email.io][git-send-email] for more information on how. + +[junction-devel]: https://lists.sr.ht/~rbdr/junction-devel +[git-send-email]: https://git-send-email.io/ |