Skip to content

Commit 16dbf71

Browse files
committed
Add CONTRIBUTING.md with branching and release workflow
1 parent fdaff38 commit 16dbf71

3 files changed

Lines changed: 42 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
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`

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ There are lots of features that can be added, and we would love to see your cont
6767

6868
If you want to contribute to this project, you can fork the repository and submit a pull request. You can also report a bug or request a feature by opening an issue.
6969

70+
See [CONTRIBUTING.md](CONTRIBUTING.md) for branching workflow and contribution guidelines.
71+
7072
Your contributions are extremely welcome and appreciated.
7173

7274
## Translations

RELEASING.md

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

0 commit comments

Comments
 (0)