diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 0000000..43a04f3 --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,31 @@ +# Zulip Recipe Maintenance +Adapted from [Traefik recipe](https://git.coopcloud.tech/coop-cloud/traefik) MAINTENANCE.md + +All contributions should be made via a pull request. This is to ensure a certain quality / 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 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 +1. Simply add yourself to the list in the [README.md](./README.md) and open a new pull request with the change. +1. Once the pull request gets merged you will be added to the [Zulip maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/zulip-maintainers). diff --git a/README.md b/README.md index 5c5406a..0db35d8 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,22 @@ +* **Maintainer**: [@sorrel](https://git.coopcloud.tech/oxaliq) +* **Status**: unstable * **Category**: Apps -* **Status**: wip +* **Features**: null * **Image**: [`zulip`](https://hub.docker.com/r/zulip), 4, upstream -* **Healthcheck**: -* **Backups**: -* **Email**: -* **Tests**: -* **SSO**: - +* **Healthcheck**: No +* **Backups**: No +* **Email**: No +* **Tests**: 0 +* **SSO**: None ## Quick start +Recipe is currently unstable, these instructions may not yield a working app. + * `abra app new zulip` * `abra app secret insert smtp_password v1 ` (A working SMTP server is required for setup) * `abra app secret g -a `