mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-11-30 05:41:12 +00:00
a07f120d12
Add a Community-Guide template was taken from [gitea](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: Anbraten <anton@ju60.de> Co-authored-by: Malachi Soord <inverse.chi@gmail.com>
30 lines
1.9 KiB
Markdown
30 lines
1.9 KiB
Markdown
# Contributing
|
|
|
|
## Maintainers
|
|
|
|
To make sure every Pull Request (PR) is checked, we have **team maintainers**.
|
|
Every PR **MUST** be reviewed by at least **one** maintainer (or owner) before it can get merged.
|
|
A maintainer should be a contributor and contributed at least 4 accepted PRs.
|
|
A contributor should apply as a maintainer in the [Discord #develop](https://discord.gg/fcMQqSMXJy) channel.
|
|
The owners or the team maintainers may invite the contributor.
|
|
A maintainer should spend some time on code reviews.
|
|
|
|
If a maintainer has no time to do that, they should apply to leave the maintainers team and we will give them the honor of being a member of the [advisors
|
|
team](https://github.com/orgs/woodpecker-ci/teams/advisors/members).
|
|
Of course, if an advisor has time to code review, we will gladly welcome them back to the maintainers team.
|
|
If a maintainer is inactive for more than 3 months and forgets to leave the maintainers team, the owners may move him or her from the maintainers team to the advisors team.
|
|
|
|
For security reasons, Maintainers must use 2FA for their accounts and if possible provide GPG signed commits.
|
|
https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/
|
|
https://help.github.com/articles/signing-commits-with-gpg/
|
|
|
|
## Owners
|
|
|
|
Since Woodpecker is a pure community organization without any company support,
|
|
to keep the development healthy we will elect two owners every year.
|
|
This can also happen when a owner propose a vote or the majority of the maintainers do so.
|
|
All maintainers may vote to elect up to two candidates. When the new owners have been elected, the old owners will give up ownership to the newly elected owners.
|
|
If an owner is unable to do so, the other owners will assist in ceding ownership to the newly elected owners.
|
|
|
|
For security reasons, Owners must use 2FA.
|
|
(https://docs.github.com/en/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa)
|