amras/docs.coopcloud.tech
0
0
Fork 0
forked from toolshed/docs.coopcloud.tech
Code Pull Requests Activity

refactor: wording, formatting & links

Browse Source
This commit is contained in:
decentral1se
2026-01-01 20:31:58 +01:00
parent 05b8c6ac26
commit 7d5ec230b8
1 changed files with 9 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/maintainers/maintain.md
View File

@ -32,15 +32,16 @@ To change this, create a new team on [`git.coopcloud.tech/coop-cloud/teams`](htt
### Repository Permissions
Under `Branch Protection` create a new rule for the `main` / `master` branch of
your repository. Add your maintainer team to the following list of permissions.
Under `Branch Protection` in the recipe repository settings, create a new rule
for the `main` / `master` branch of your repository. Add your maintainer team
to the following list of permissions.
* Allow only maintainers to push directly to the main branch
* `Allowlist Restricted Push` > `Allowlisted teams for pushing`
* `Allowlist Restricted Push` > `Allowlisted teams for pushing`
* Allow only maintainers to approve pull requests
* `Restrict approvals to allowlisted users or teams` > `Allowlisted teams for reviews`
* `Restrict approvals to allowlisted users or teams` > `Allowlisted teams for reviews`
* Allow only maintainers to merge pull requests
* `Enable Merge Allowlist` > `Allowlisted teams for merging`
* `Enable Merge Allowlist` > `Allowlisted teams for merging`
## Templates
@ -51,56 +52,10 @@ your repository. Add your maintainer team to the following list of permissions.
We are still considering if it is a good idea to create a `MAINTENANCE.md`
for every recipe repository. Maybe it is a better idea to make a single
`MAINTENANCE.md` on [docs.coopcloud.tech](https://docs.coopcloud.tech). We
look forward to your input.
look forward to seeing feedback on this from new maintainers.
```
# <RECIPE> 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.
## Become a maintainer
Everyone can apply to be a recipe maintainer. Simply add your self to the list
in the [README.md](./README.md) and open a new pull request with the change.
```
See the [`MAINTENANCE.md`](https://git.coopcloud.tech/coop-cloud/traefik/raw/branch/master/MAINTENANCE.md) of the Traefik recipe.
### Pull request template
```
---
name: "<RECIPE> pull request template"
---
<!--
Thank you for doing recipe maintenance work!
Please mark all checklist items which are relevant for your changes.
Please remove the checklist items which are not relevant for your changes.
Feel free to remove this comment.
-->
* [ ] I have deployed and tested my changes
* [ ] I have [updated relevant versions in `abra.sh`](#TODO)
* [ ] I have made my environment variable changes [backwards compatible](#TODO)
* [ ] I have added a [release note entry](#TODO)
```
See the [`.gitea/PULL_REQUEST_TEMPLATE.md`](https://git.coopcloud.tech/coop-cloud/traefik/src/branch/master/.gitea/PULL_REQUEST_TEMPLATE.md) of the Traefik recipe.