diff --git a/.gitea/PULL_REQUEST_TEMPLATE.md b/.gitea/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..9e10a8a --- /dev/null +++ b/.gitea/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +--- +name: "Rauthy pull request template" +about: "Rauthy pull request template" +--- + + + +* [ ] I have deployed and tested my changes +* [ ] I have [updated relevant versions in `abra.sh`](https://docs.coopcloud.tech/maintainers/upgrade/#updating-versions-in-the-abrash) +* [ ] I have made my environment variable changes [backwards compatible](https://docs.coopcloud.tech/maintainers/upgrade/#backwards-compatible-environment-variable-changes) +* [ ] I have added a [release note entry](https://docs.coopcloud.tech/maintainers/upgrade/#creating-new-release-notes) diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 0000000..ba855df --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,32 @@ +# Rauthy Recipe Maintenance + +All contributions should be made via a pull request. This is to ensure a +certain quality and consistency, that others can rely on. + +## Maintainer Responsibilities + +A recipe maintainer has the following responsibilities: + +- Respond to pull requests / issues within a week +- Make image security updates within a day +- Make image patch / minor updates within a week +- Make image major updates within a month + +In order to fullfill these responsibilities a recipe maintainer: + +- Has to watch the repository (to get notifications) +- Needs to make sure renovate is configured properly + +## Pull Requests + +A pull request can be merged if it is approved by at least one maintainer. For +pull requests opened by a maintainer they need to be approved by another +maintainer. Even though it is okay to merge a pull request with one approval, it +is always better if all maintainers looked at the pull request and approved it. + +## Become a maintainer + +Everyone can apply to be a recipe maintainer: +1. Watch the repository to always get updates +2. Simply add your self to the list in the [README.md](./README.md) and open a new pull request with the change. +3. Once the pull request gets merged you will be added to the [rauthy maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/rauthy-maintainers). diff --git a/README.md b/README.md index 1939de2..5200721 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ +* **Maintainer**: [@3wc](https://git.coopcloud.tech/3wordchant), [@decentral1se](https://git.coopcloud.tech/decentral1se) * **Category**: Apps * **Status**: 0 * **Image**: [`rauthy`](https://ghcr.io/sebadob/rauthy), 4, upstream