adds maintenance and updates readme

2026-08-26 13:19:22 +02:00
parent a9497fea18
commit 3a8164d3a1
2 changed files with 34 additions and 1 deletions
@@ -0,0 +1,32 @@
+# Hedgedoc 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 two weeks
+- Make image security updates within a week
+- Make image major updates every three months
+
+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 [hedgedoc maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/hedgedoc-maintainers).
+4. Join the room [#cc-|-hedgedoc-maintenance:matrix.org](#cc-|-hedgedoc-maintenance:matrix.org) and chat to other maintainers.