aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.org
blob: cfcfe8650ab9e306375ae60f525a8a9accd92477 (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
46
* 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.

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.                      |
|---------+-----------------------------------------------------------------|


** 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".
** Making code contributions

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, use the
mailing list to request that your branch be merged into the relevant
release candidate branch.

If requesting a merge is infeasible because your git repository is
private or local to your machine, you may submit a patch against the
relevant release candidate branch via the mailing list.


>>>>>>> develop