aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.org
blob: c242b1defbbf6af15430e032ae5d73ca90ca0d57 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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.