summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam Casarin <jb55@jb55.com>2018-10-17 10:23:46 -0700
committerWilliam Casarin <jb55@jb55.com>2018-10-17 10:24:43 -0700
commit775380ba5d29d9b4057440e6a86f69e0d0213585 (patch)
treeffc8f1127e7c554a6a9e47e9b49f66028ac8780a
parent37881fc5c5bd1047b703f6b3ad5f851c7021b808 (diff)
CONTRIBUTING
-rw-r--r--CONTRIBUTING50
1 files changed, 50 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..c2cd582
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,50 @@
+
+Reporting bugs
+==============
+
+Please submit bugs to our issue tracker here:
+
+ https://todo.sr.ht/~jb55/cmdtree
+
+You can also send questions to the public mailing list:
+
+ To: ~jb55/public-inbox@lists.sr.ht
+ Subject: [cmdtree] <question>
+
+
+Contributing code
+=================
+
+Feel free to email patches to:
+
+ ~jb55/public-inbox@lists.sr.ht
+
+Use git-format-patch and git-send-email.
+
+
+Getting started
+---------------
+
+replace <branch> with your branch:
+
+ mkdir -p patches/<branch>
+
+ git config format.subjectPrefix 'PATCH cmdtree'
+
+
+Sending a patch
+---------------
+
+replace <branch> with your branch
+
+
+ git format-patch --output-directory=patches/<branch> \
+ --cover-letter \ # (optional)
+ <branch>^
+
+ $EDITOR 0000-cover-letter.patch # (optional)
+
+ git send-email --to="~jb55/public-inbox@lists.sr.ht" \
+ patches/<branch>/*.patch
+
+