summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2017-04-23 23:02:35 +0300
committerAndrew Dolgov <[email protected]>2017-04-23 23:02:35 +0300
commit3ca926297d27082885d25b6f3e9c5675d9395cfa (patch)
tree22b8dff55de118bfe739297cb292b98bb344821d
parent67843eabbacce8cd29a30bc1114bb126e632b31e (diff)
Add contribution guide
-rw-r--r--CONTRIBUTING.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..172084f5
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+## Contributing code the right way
+
+*or: how I learned to post merge requests without crying myself to sleep*
+
+1. Post your idea on the forums. Preferably post diffs if you got them. Mention your gitlab username.
+2. If your idea was accepted, request developer permissions for the project via Gitlab.
+2. When you have developer privileges you can make branches, check them out, work on them locally, push them back and post merge requests.
+3. Usual stuff applies: don't post unrelated issues in one merge request, try to not screw up indenting (tt-rss mostly uses tab characters), try to respect surrounding formatting style, etc.
+4. That's it. \ No newline at end of file