[FEATURE] CI: Add PSR-12 check

[jirafeau.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 876ef7bc0947b250a9540766a42337c9b0b92f14..06929221499a5ff4438300c299e8dc8be0b8b911 100644 (file)
--- 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```
 * 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```
 * 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,13 +90,16 @@ Quick walktrough:
 
 ## New Releases
 
 
 ## New Releases
 

+* If the release is not done for security purposes: create a new issue and freeze next-release branch for at least week.
+* Make sure to run `php-cs-fixer fix --rules=@PSR2 .` and commit.

 * Compare the [»next-release« branch to »master«](https://gitlab.com/mojo42/Jirafeau/compare/master...next-release)
 * 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`
+* Build and test docker image

 * Change the version, using [semantic versioning](http://semver.org/), in ```settings.php```
 * Merge »next-release« branch to »master«
 * 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
 * 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
 * Dance a little