Skip to content

Commit 48c4221

Browse files
committed
add readme-contributing
1 parent 7c2805b commit 48c4221

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

readme-contributing.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## repository structure
2+
3+
### current branches:
4+
5+
- `main`: currently active development branch. pretty much every PR should be opened against `main` (with possible exception of hotfixes for norns.) may have bugs.
6+
7+
- `norns-latest`: this will attempt to track the commit pointed at by the `softcut` submodule in the main branch of `monome/norns` repo.
8+
9+
- `v1.5`: current version branch. `main` should be merged into here whenever it's deemed stable enough for testing.
10+
11+
- `v2-wip`: this branch contains "backlogged" changes intended for a v2 overhaul. involves extensive and complicated changes to the processing architecture. it's not yet working, hence the backlog, but it reopresents enough work to be worth saving. will be "salvaging" changes from here to release as v1.5.
12+
13+
### working branches:
14+
15+
other working branches branches may exist, and should be named using a prefix and a slash. one of:
16+
17+
`fix/` - for bugfixes and performance improvements.
18+
`feature/`- for new user-facing features
19+
`dev/` for primarily developer-facing work, like refactoring or architecture changes.
20+
21+
if you are part of the `monome` organization, go ahead and make your development branch in the main repo.
22+
if you're not, make your working branch on your own fork.

0 commit comments

Comments
 (0)