diff options
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/contributing-code-to-northstar.md | 5 | ||||
| -rw-r--r-- | docs/development/releases.md | 4 |
2 files changed, 7 insertions, 2 deletions
diff --git a/docs/development/contributing-code-to-northstar.md b/docs/development/contributing-code-to-northstar.md index 98cf770..37e881c 100644 --- a/docs/development/contributing-code-to-northstar.md +++ b/docs/development/contributing-code-to-northstar.md @@ -31,6 +31,11 @@ To get the cropped GIFs of a screenrecording: (The linked site has not been vetted, use at own risk) 4. Upload GIF to GitHub pull request description by just pasting it at the appropriate location. +### Useful links + +- [How to write a commit message](https://cbea.ms/git-commit/) +- [Atomic commits](https://www.freshconsulting.com/insights/blog/atomic-commits/) + ### Avoiding "PR hell" _"PR hell"_ is what contributors refer to when a pull request is stuck as pending without any indication for progress. diff --git a/docs/development/releases.md b/docs/development/releases.md index 4145f0c..aed3b3d 100644 --- a/docs/development/releases.md +++ b/docs/development/releases.md @@ -27,9 +27,9 @@ The process is ever changing in order to simplify it so these steps outlined mig The current process of making release (includinging release candidate) is: -1. Make release branch (`MAJOR.MINOR.X`) (if not exists) +1. Make release branch (`MAJOR.MINOR.X`) (only if commits need to be cherry-picked) -2. Merge desired commits from `main` +2. Take desired commits from `main` - Make sure to consider whether changing are breaking in regards to older/newer server/client and in regards to Squirrel API. - Older/newer client/server breakage might need to be version gated and should **NOT** be done in patch releases. - Squirrel API changes likely breaks mods and should **NOT** be done in patch releases. Additionaly make sure to ping modders on release or preferably even in advance. |