diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57e1f0e..4bc9fb4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,27 @@ # Contributing to MADR -- Homepage: Contribute to `gh-pages` branch (using a pull request). - The `docs/` folder of the `gh-pages` branch is the base of the content of . -- Template: Contribute to `develop` branch (using a pull request). - The subdirectory `docs/` will be the new homepage after a release. - The current state is rendered at . -- Older version of the template: `develop/v{x}`, where `{x}` is the major version you want to contribute. - In case no such branch exists, contribute to `release/v{x}`. - We will create the respective development branch. +## Homepage + +Homepage: Contribute to `gh-pages` branch (using a pull request). +The `docs/` folder of the `gh-pages` branch is the base of the content of . + +## Template: Next version + +Template: Contribute to `develop` branch (using a pull request). +The subdirectory `docs/` will be the new homepage after a release. +The current state is rendered at . As soon as a pull request is made, [netlify](https://www.netlify.com/) kicks off a build. After a successful build, the link to the build is put as a comment to the pull request for inspection. + +We use `develop` as branch name, because the name `main` does not definitively indicate whether it is the latest releae or the development version. + +## Template: Patches to releases + +The most recent releases of each major version are stored in the branch `release/v{x}`. +It is a branch, because the release version changes (and there are git users who do not like changing tags). + +Please submit a pull request to that branch. +In case there are multiple fixes, we create a new branch `develop/v{x}` on demand. + +Reasing: Wish at [#92](https://github.com/adr/madr/issues/92)