X-Git-Url: https://git.p6c8.net/jirafeau.git/blobdiff_plain/70d841a8fc4727b02da6adde3ad12326430d87a8..55792c618cf87bef72092840f7bd676d0a3d079f:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dfa5d55..245a6e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,6 +81,8 @@ Quick walktrough: * Fork the original repository, clone the own repository, add the original repository as upstream * Checkout »next-release« branch ```git checkout next-release``` * Create a new branch on top of that one, e.g. »some-feature« ```git checkout -b some-feature``` +* Make your change +* You may check if the project is still [REUSE Compliant](https://reuse.software/) by running `docker run -v $(pwd):/code --rm fsfe/reuse /bin/sh -c "cd /code && reuse lint"` * Commit changes → push → send merge request ```git add -A; git commit; git push``` MR via GitLab (link shown in console) * Feature is reviewed * MR accepted: Reviewer checks out »next-release« branch and cherry-picks the commit ```git checkout next-release; git cherry-pick be4369641; git push``` @@ -88,10 +90,10 @@ Quick walktrough: ## New Releases -* If the release is not done for security purposes, freeze next-branch for at least week. +* If the release is not done for security purposes: create a new issue and freeze next-release branch for at least week. * Compare the [»next-release« branch to »master«](https://gitlab.com/mojo42/Jirafeau/compare/master...next-release) -* Add a list of noteworthy features and bugfixes to the README -* Fill upgrade procedure in README +* Add a list of noteworthy features and bugfixes to `CHANGELOG.md` +* Add eventual upgrade procedure to `CHANGELOG.md` * Change the version, using [semantic versioning](http://semver.org/), in ```settings.php``` * Merge »next-release« branch to »master« * Update the demo page