Skip to content

Commit d27f02e

Browse files
Optimize PR processes (#1538)
1 parent 63617fa commit d27f02e

4 files changed

Lines changed: 43 additions & 52 deletions

File tree

.github/PULL_REQUEST_TEMPLATE/lite.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE/substantial.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Substantial PR
22

3-
> Use this template for PRs that change behavior, introduce new concepts, or would hurt if they broke.
3+
> Use this template for PRs that introduce significant changes.
44
>
55
> This template exists to keep reviewers from reverse-engineering context, risk, and intent from the diff.
66
>
@@ -201,4 +201,5 @@ Call out:
201201
- [ ] I reviewed every line of this diff and understand it end-to-end
202202
- [ ] I'm prepared to defend this PR line-by-line in review
203203
- [ ] I'm comfortable being the on-call owner for this change
204-
- [ ] Relevant changesets are included (or explicitly not required)
204+
- [ ] Relevant changesets are included (or are not required)
205+
- *Tip: [Changesets](https://ensnode.io/docs/contributing/releases/#adding-a-changeset-to-your-pr) should be created / written to optimize for the narrative of the next autogenerated [release notes](https://github.com/namehash/ensnode/releases).*

.github/pull_request_template.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,40 @@
1-
# Choose a PR template
1+
# Lite PR
22

3-
Use the appropriate template for this PR:
3+
## Summary
44

5-
- [**Light PR**](https://github.com/namehash/ensnode/compare/main...HEAD?template=lite.md)
6-
For small, low-risk changes (mechanical refactors, formatting, dependency bumps).
5+
- What changed (1-3 bullets, no essays).
76

8-
- [**Substantial PR**](https://github.com/namehash/ensnode/compare/main...HEAD?template=substantial.md)
9-
For behavior changes, consumer impact, new concepts, or high-risk work.
7+
---
108

11-
If you're unsure, that suggests this PR is a **Substantial PR**.
9+
## Why
10+
11+
- Why this change exists. Link to related GitHub issues where relevant.
12+
13+
---
14+
15+
## Testing
16+
17+
- How this was tested.
18+
- If you didn't test it, say why.
19+
20+
---
21+
22+
## Notes for Reviewer (Optional)
23+
24+
- Anything non-obvious or worth a heads-up.
25+
26+
---
27+
28+
## Pre-Review Checklist (Blocking)
29+
30+
- [ ] This PR does not introduce significant changes and is low-risk to review quickly.
31+
- [ ] Relevant changesets are included (or are not required)
32+
33+
<details>
34+
<summary>PR Creation Tips</summary>
35+
36+
- If this PR introduces significant changes or is higher-risk to review use the "[Substantial PR](https://github.com/namehash/ensnode/compare/main...HEAD?template=substantial.md)" template instead.
37+
- [Changesets](https://ensnode.io/docs/contributing/releases/#adding-a-changeset-to-your-pr) should optimize for the narrative of the next [autogenerated release notes](https://github.com/namehash/ensnode/releases). Optimize for how the resulting release notes will read to a developer in the ENS Ecosystem. Communicate all ideas with a positive frame.
38+
- The "Require PR Description Checks" GitHub Action will report a failing CI check on non-draft PRs where there are unchecked checkboxes in the description. You should therefore make your PR a draft PR until it is ready for review.
39+
40+
</details>

.github/workflows/require_pr_checks.yml renamed to .github/workflows/require_pr_description_checks.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
name: Require PR Checks
1+
name: Require PR Description Checks
22

33
on:
44
pull_request:
5-
types: [opened, edited, synchronize]
5+
types: [opened, reopened, edited, ready_for_review, converted_to_draft]
66

77
jobs:
8-
require-pr-checks:
8+
require-pr-description-checks:
9+
if: ${{ github.event.pull_request.draft != true }} # skip on draft PRs
910
runs-on: blacksmith-4vcpu-ubuntu-2204
1011
steps:
1112
- uses: mheap/require-checklist-action@v2

0 commit comments

Comments
 (0)