Skip to content

Commit ed3cf30

Browse files
committed
Add CONTRIBUTING.md with branching and release workflow
1 parent 57966fe commit ed3cf30

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
## Branches
4+
5+
- `dev` — default branch, all PRs go here
6+
- `main` — releases only, string frozen for translations
7+
8+
## Workflow
9+
10+
1. Create a branch from `dev`
11+
2. Open a PR targeting `dev`
12+
3. Merge to `dev`
13+
14+
## Releasing
15+
16+
1. Create a release branch from `dev`:
17+
```bash
18+
git checkout dev
19+
git pull
20+
git checkout -b release/X.Y.Z
21+
```
22+
2. Update version in `meson.build` following [Semantic Versioning](https://semver.org/)
23+
3. Update `data/io.github.revisto.drum-machine.metainfo.xml` with release notes
24+
4. Commit and push:
25+
```bash
26+
git add meson.build data/io.github.revisto.drum-machine.metainfo.xml
27+
git commit -m "Release X.Y.Z"
28+
git push origin release/X.Y.Z
29+
```
30+
5. Open a PR targeting `main` and merge it
31+
6. Announce string freeze on [GNOME Discourse](https://discourse.gnome.org/) and Matrix room
32+
33+
7. Wait for string freeze (1-2 weeks depending on changes)
34+
35+
8. Tag and push after translations are complete:
36+
```bash
37+
git tag vX.Y.Z
38+
git push origin --tags
39+
```
40+
41+
9. Release to Flathub

0 commit comments

Comments
 (0)