From: Ben Beltran <redacted>
Date: Sun, 22 Dec 2019 23:40:13 +0000 (+0100)
Subject: Add a contributing guide
X-Git-Url: https://git.r.bdr.sh/rbdr/forum/commitdiff_plain/2b8a9e46fd81b39bdee21de1c81ed8549759f835

Add a contributing guide
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..aedf551
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# Contributing to Forum
+
+At this moment Forum is a toy project intended to experiment with ideas
+for an internet forum based on the past's future.
+
+## The objective of Forum
+
+The main objective is to create a Forum that we would be proud to use in
+a 90s interpretation of the internet of tomorrow. Any contribution that
+would push in that direction, or improve the code or processes around it
+is welcome! :)
+
+Some ideas so far include:
+
+* Ephemeral posts
+* Physical tokens for login
+* Magic glyphs generated from username
+* Posts can be categorized by forum or tag, or be completely unlisted
+* Flagging with option to publish/subscribe to flags
+* Signatures
+
+## How to contribute
+
+Above All: Be nice, always.
+
+* Ensure the style checkers show no warnings or errors
+* Don't break the CI
+* Make the PRs according to [Git Flow][gitflow]: (features go to
+  develop, hotfixes go to master)
+
+[gitflow]: https://github.com/nvie/gitflow