aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.org
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.org')
-rw-r--r--CONTRIBUTING.org40
1 files changed, 16 insertions, 24 deletions
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
index 9d896ee..dbbe82e 100644
--- a/CONTRIBUTING.org
+++ b/CONTRIBUTING.org
@@ -6,35 +6,27 @@ 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.
+At any moment, there are three branches:
+
+| BRANCH | PURPOSE |
+|---------+-----------------------------------------------------------------|
+| main | Where stable releases reside. Each taggged with a version. |
+|---------+-----------------------------------------------------------------|
+| rc | The release candidate branch. Courageous may build and test the |
+| | this branch prior to its release. Bugfix patches and PRs |
+| | are submitted to rc. |
+|---------+-----------------------------------------------------------------|
+| develop | Where new features are actively developed. |
+|---------+-----------------------------------------------------------------|
-When a release candidate is "accepted", it will be merged into main
-and the commit will be tagged with the version.
** Suggesting Features & Reporting Bugs
+To bring something up with the developers, send an email to
+
+ ~cbeo/oneliners.wiki@lists.sr.ht
+
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
-the relevant release candidate branch 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.
-
-