added contributor guide

1 files changed, 45 insertions, 0 deletions

diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
new file mode 100644
index 0000000..c242b1d
--- /dev/null
+++ b/CONTRIBUTING.org
@@ -0,0 +1,45 @@
+* Basic Info 
+
+** Release Schedule 
+
+Prior to 1.0.0, there will be a weekly release each Friday.
+
+After 1.0.0, a new release schedule will be decided upon.
+
+Each release is developed in a branch called rc-<major>.<minor>,
+referring to the major and minor versions in semver. 
+
+These branches are based off of the dev branch, meaning that any one
+of them should be able to merge dev at any point - merge conflicts
+from dev into an rc branch are not allowed.
+
+When a release candidate is "accepted", it will be merged into main
+and the commit will be tagged with the version.  At that point dev
+should also be updated from main.
+
+** Suggesting Features & Reporting Bugs
+
+To keep up with developments and discuss this tool, join the mailing
+list by visiting https://lists.sr.ht/~cbeo/oneliners.wiki and hitting
+"subscribe".
+
+As a convenience to the maintainer(s), please categorize your message
+by starting the subject line with one of the following:
+
+- [FEATURE CLI] For feature requests 
+- [ISSUE CLI] For issue / bug reports 
+- [PATCH vN] For patches (use git send-email)
+- [GENERAL CLI] For anything else
+
+** Branch based collaboration
+
+If you want to work on a feature, please make a new branch based on
+dev and develop your features there. 
+
+If the maintainer (me, Colin) has access to your git repo, simply
+request that your branch be merged into the relevant release candidate
+branch via the mailing list.
+
+Otherwise submit a patch against the release candidate branch.
+
+