Skip to content

Commit 4eb8bb6

Browse files
authored
chore: update pr template to help reduce review effort (#9350)
update pr template Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
1 parent 3380fc2 commit 4eb8bb6

2 files changed

Lines changed: 31 additions & 16 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
1-
**What type of PR is this?**
21
<!--
3-
Your PR title should be descriptive, and generally start with type that contains a subsystem name with `()` if necessary
4-
and summary followed by a colon. format `chore/docs/api/feat/fix/refactor/style/test: summary`.
2+
Your PR title should be descriptive, and generally start with a type that contains a subsystem name with `()` if necessary
3+
and a summary followed by a colon. format `chore/docs/api/feat/fix/refactor/style/test: summary`.
54
Examples:
65
* "docs: fix grammar error"
76
* "feat(translator): add new feature"
87
* "fix: fix xx bug"
98
* "chore: change ci & build tools etc"
109
* "api: add xxx fields in ClientTrafficPolicy"
11-
12-
Before raising a PR, please go through this section of the developer guide, https://gateway.envoyproxy.io/community/develop/#raising-a-pr
1310
-->
1411

1512
<!--
16-
NOTE: If your PR contains any API changes (changes under `/api`), we recommend you to separate these API changes into
17-
a new PR, and we will review the API part first. It will save you lots of implementation time if the API get accepted.
13+
NOTE: If your PR contains any API changes (changes under `/api`), the API must be discussed and
14+
agreed before the implementation. We strongly recommend separating API changes into their own PR so
15+
we can review the API first, but the API may also live in the same PR as long as it was agreed
16+
beforehand. This will save you a lot of implementation time if the API gets accepted.
1817
-->
1918

2019
**What this PR does / why we need it**:
20+
<!--
21+
Briefly describe what this PR changes and the motivation behind it. Include enough context for a
22+
reviewer to understand the problem being solved and the approach taken, e.g. what behavior changes,
23+
any alternatives considered, and anything reviewers should pay special attention to.
24+
-->
2125

2226
**Which issue(s) this PR fixes**:
2327
<!--
@@ -26,9 +30,23 @@ Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
2630
-->
2731
Fixes #
2832

33+
---
34+
35+
**PR Checklist**
2936
<!--
30-
For any non-trivial changes, you need to provide a brief description of the changes in the release notes.
31-
Please add a new fragment file under release-notes/current/<section>/<pr-number>-<slug>.md and include it in the PR.
32-
See release-notes/current/README.md for the available sections and the naming convention.
37+
Please tick the boxes below before requesting a review. PRs that leave required items unchecked may
38+
be delayed or closed. Replace `[ ]` with `[x]` to check a box. If an item does not apply, check it
39+
and add "N/A: <reason>".
3340
-->
34-
Release Notes: Yes/No
41+
42+
- [ ] **Authorship & ownership**: Coding agents / AI assistants are welcome, but I have reviewed every change, understand how and why it works, can explain and maintain it, and take full responsibility for this PR. I have not submitted generated output I do not understand.
43+
- [ ] **DCO**: All commits are signed off (`git commit -s`). See [DCO: Sign your work](https://gateway.envoyproxy.io/community/contributing/#dco-sign-your-work).
44+
- [ ] **API agreed first**: If this PR contains API changes (changes under `/api`), the API was discussed and agreed **before** the implementation. The API change can be in a separate PR, or in the same PR, but the API must be agreed before implementation. N/A if this PR does not contain API changes.
45+
- [ ] **Required checks pass**: `make generate gen-check`, `make lint`, and the unit-test/coverage build pass. (Flaky e2e failures are not considered breakages, but `gen-check`, `lint`, and coverage **MUST** pass.)
46+
- [ ] **Tests added/updated**: New/changed code is covered by appropriate tests. N/A if this PR does not contain code changes.
47+
- [ ] **Docs**: User-facing changes update the [docs](https://github.com/envoyproxy/gateway/tree/main/site), either in this PR or a follow-up PR. N/A if this PR does not contain user-facing changes.
48+
- [ ] **Release notes**: For any non-trivial change, added a release-note fragment under `release-notes/current/<section>/<pr-number>-<slug>.md` (see `release-notes/current/README.md` for sections and naming). N/A if this PR does not contain non-trivial changes.
49+
- [ ] **Generated files committed**: Ran `make gen-check` and committed the result if API/helm charts/modules changed.
50+
- [ ] **Scope & compatibility**: The PR is reasonably scoped (no unrelated changes) and preserves backward compatibility, or any breaking change is called out above and documented in `release-notes/current/breaking_changes/`.
51+
- [ ] **Codex review**: Requested a Codex review and addressed all of its comments.
52+
- [ ] **Copilot review**: Requested a Copilot review and addressed all of its comments.

release-notes/current/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# Release notes for the next release
22

3-
Add your release note here as a **new file**, instead of editing a shared
4-
`current.yaml`. Because every change is its own file, concurrent PRs no longer
5-
conflict on the release notes. This mirrors Envoy's
6-
[`changelogs/current`](https://github.com/envoyproxy/envoy/tree/main/changelogs/current)
7-
approach.
3+
This directory holds release notes for the next release. Document each change by
4+
adding a **new file** under the matching section directory, as described below.
85

96
## How to add an entry
107

0 commit comments

Comments
 (0)