From: Ruben Beltran del Rio <redacted>
Date: Fri, 15 Sep 2023 16:08:03 +0000 (+0200)
Subject: Add a contributing guide
X-Git-Url: https://git.r.bdr.sh/rbdr/junction/commitdiff_plain/650c5f155e98dc8428ab617a535541736c9dd08f?ds=sidebyside

Add a contributing guide
---

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/