📚 Set clearer expectations for PR reviews and prior discussion

Explicitly state that the team is small and reviews may take a
few days as they are handled in dedicated time blocks.

Remove mention of GitHub Discussions since it is not used.

Reword the discussion requirement to manage expectations: do not
expect a PR to be accepted without prior discussion.

Signed-off-by: Andrey Antukh <niwi@niwi.nz>
This commit is contained in:
Andrey Antukh 2026-04-29 14:26:53 +00:00
parent fd170b23f6
commit 05b4760583

View File

@ -63,12 +63,11 @@ Advisories](https://github.com/penpot/penpot/security/advisories)
1. **Read the DCO** — see [Developer's Certificate of Origin](#developers-certificate-of-origin-dco) 1. **Read the DCO** — see [Developer's Certificate of Origin](#developers-certificate-of-origin-dco)
below. All code patches must include a `Signed-off-by` line. below. All code patches must include a `Signed-off-by` line.
2. **Discuss before building** — open a [GitHub 2. **Discuss before building** — open a [GitHub
Issue](https://github.com/penpot/penpot/issues) or start a [GitHub Issue](https://github.com/penpot/penpot/issues) before starting work on
Discussion](https://github.com/penpot/penpot/discussions) before starting a new feature or significant change. For planned features on the roadmap,
work on a new feature or significant change. For planned features on the reference the corresponding Taiga story. Do not expect your contribution
roadmap, reference the corresponding Taiga story. No PR will be accepted to be accepted if you submit it without prior discussion — this applies
without prior discussion, whether it is a new feature, a planned one, or a to new features, planned features, and quick wins alike.
quick win.
3. **Bug fixes** — you may submit a PR directly, but we still recommend 3. **Bug fixes** — you may submit a PR directly, but we still recommend
filing an issue first so we can track it independently of your fix. filing an issue first so we can track it independently of your fix.
4. **Format and lint** — run the checks described in 4. **Format and lint** — run the checks described in
@ -136,7 +135,11 @@ refactor/layout-sizing
### Review process ### Review process
- Maintainers review PRs when time permits. Please be patient. - We are a small team and maintainers juggle reviews alongside other
tasks. Please do not expect your code to be reviewed instantly.
- Reviews are handled in dedicated blocks of time, usually in the order
PRs arrive. It may take a few days to get a first review, especially
when urgent tasks come up.
- Address review feedback by **pushing new commits** — do not - Address review feedback by **pushing new commits** — do not
force-push during review, as it breaks comment threads. force-push during review, as it breaks comment threads.
- PRs require at least **one approval** before merge. - PRs require at least **one approval** before merge.