Kessinen/foodster
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 3 Wiki Activity

docs: use release: for squash-merged release pull requests

Browse Source 
A release spans a fix, a feature and some chores at once, so no single
conventional type describes it honestly. release: makes main's log one line
per deployment, which is what that branch is for, with the pull request body
as the notes.
This commit is contained in:
Esa Kataja
2026-09-06 00:01:25 +03:00
parent b9e0d8d65d
commit 0d01f6e8dd
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+14 -1
View File
@@ -59,8 +59,21 @@ alternative was — the diff already says what changed. If a fix was subtle,
say what made it subtle; if a test caught something, say what. Commits here say what made it subtle; if a test caught something, say what. Commits here
are the only design record this project has. are the only design record this project has.
### Release pull requests
Because `main` is squash-merged, a pull request title becomes a commit message Because `main` is squash-merged, a pull request title becomes a commit message
on `main`. Give it the same treatment. on `main`. A release spans a fix, a feature and some chores at once, so none
of the types above fits it honestly. Use `release:` instead:
```
release: repair the catalog 404 and stop the page jumping
```
`main`'s log is then one line per deployment, which is what that branch is
for, and the pull request body serves as the release notes. No version in the
title — the CalVer tag is not created until `make image` runs after the merge.
The types above are for `dev`, where a commit really does do one thing.
## Things that are easy to get wrong ## Things that are easy to get wrong