docs: Maintainers, assemble! #7
33
MAINTENANCE.md
Normal file
33
MAINTENANCE.md
Normal file
@ -0,0 +1,33 @@
|
||||
# Headscale 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
|
||||
|
||||
`3wc` is responsible for installing regular updates:
|
||||
|
||||
- Patch and minor updates within a week of them being released upstream
|
||||
- Major updates within a month of them being released upstream
|
||||
|
||||
`ammaratef45` is responsible for responding to pull requests and issues, within a week of them being filed.
|
||||
|
||||
In order to fulfill 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 yourself to the list in the [README.md](./README.md), add yourself to whichever things you would like to be (co) responsible for in this document, then open a new pull request with the change.
|
||||
3. Once the pull request gets merged you will be added to the [headscale maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/headscale-maintainers).
|
||||
@ -4,8 +4,10 @@
|
||||
|
||||
<!-- metadata -->
|
||||
|
||||
* **Maintainer**: [@3wc](https://git.coopcloud.tech/3wordchant), [@ammaratef45](https://git.coopcloud.tech/ammaratef45)
|
||||
* **Status**: `stable`
|
||||
* **Category**: Apps
|
||||
* **Status**: 3
|
||||
* **Features**: 3
|
||||
* **Image**: [`headscale/headscale`](https://hub.docker.com/r/headscale/headscale), 4, upstream
|
||||
* **Healthcheck**: Yes
|
||||
* **Backups**: Yes
|
||||
|
||||
Reference in New Issue
Block a user