X-Git-Url: https://git.p6c8.net/jirafeau_project.git/blobdiff_plain/b416a48deb74471af16cb02cd95adf1cd689ffb7..33bb6cfe3111b316082336edae43846aaef84f17:/CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c41c4d9..e7ee9c3 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,12 +90,15 @@ Quick walktrough: ## New Releases +* 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 +* Add a list of noteworthy features and bugfixes to `CHANGELOG.md` +* Add eventual upgrade procedure to `CHANGELOG.md` +* Build and test docker image * Change the version, using [semantic versioning](http://semver.org/), in ```settings.php``` * Merge »next-release« branch to »master« -* Update the demo page * Tag the »master« with the new version * Push branch and tag -* Build & push new docker image +* Push new docker image +* Update the demo page * Dance a little