Add pull request template - #144
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
There was a problem hiding this comment.
Review
This is a clean, well-scoped change that adds a single .github/pull_request_template.md. It qualifies as exactly the kind of small, trivially-verifiable PR the contribution policy welcomes.
Verified
- Links resolve.
CONTRIBUTING.mdexists onmain(repo default branch ismain), so the guidelines link is valid. Discussions are enabled, so the discussions link is valid. - Policy is faithfully summarized. The template's language ("small, trivially verified", "not a feature, refactor, or low-value cleanup such as a typo fix", "about a dozen changed lines") matches
CONTRIBUTING.md(lines 7-9) without overstating or contradicting it. - No whitespace issues.
git diff --checkis clean. - Markdown is well-formed. The GitHub
> [!IMPORTANT]alert and the checklist render correctly.
Notes (non-blocking)
- The stable hidden identifiers (
<!-- contribution-policy:concrete-fix -->etc.) are a nice touch for future automation. Just flagging that they're currently unused — worth a follow-up that actually consumes them, otherwise they're only documentation. Not a blocker. - The checklist places the HTML comment before the visible text on each
- [ ]line, which renders fine and keeps the marker out of view. Good.
Looks good to me. Nice, focused contribution.
|
Review posted to PR #144. SummaryPR #144 adds a single I verified:
Non-blocking notes I raised: the hidden Overall: approvable, no changes required. |
|
I have read the CLA Document and I hereby sign the CLA |
| > trivially verified pull requests that fix a concrete problem. Please read our | ||
| > [contribution guidelines](https://github.com/cloudflare/cloudflare-os/blob/main/CONTRIBUTING.md) | ||
| > before submitting. For larger changes, please start a | ||
| > [discussion](https://github.com/cloudflare/cloudflare-os/discussions) instead. |
There was a problem hiding this comment.
Let's separate:
- For bugs, file an issue.
- For feature requests, open a discussion.
There was a problem hiding this comment.
Updated the template to direct bug reports to Issues and feature requests or other proposals to Discussions.
| discussion instead. Pull requests that do not meet these criteria will be closed. | ||
|
|
||
| - [ ] <!-- contribution-policy:concrete-fix --> This fixes a concrete problem; it is not a feature, refactor, or low-value cleanup such as a typo fix. | ||
| - [ ] <!-- contribution-policy:small-patch --> This patch is about a dozen changed lines and can be fully verified by reading it. |
There was a problem hiding this comment.
I wonder if we can also capture whether it is "obviously correct"... There have been some PRs that were only a few lines but the effects were subtle, e.g. disabling a feature for ollama so that the adapter worked with arbitrary OpenAI-compatible endpoints. It's one line but the effects are hard to judge.
Maybe we should actually remove this triviality condition entirely and just say we don't accept PRs, otherwise people might get annoyed when they open a one-liner and we decide it isn't sufficiently trivial.
There was a problem hiding this comment.
how about
We are not generally accepting outside contributions. We may accept a small
change only when, in the maintainers' assessment, it is obviously correct and
trivially verifiable by reading the patch.
i think proactively sharing that it is in the "maintainers' assessment" is reasonable and not that uncommon.
There was a problem hiding this comment.
I kept the narrow exception, but clarified that acceptance depends on the maintainers' assessment that the change is both obviously correct and trivially verifiable. I also removed the line-count language so a small diff is not presented as sufficient.
There was a problem hiding this comment.
Review
The head commit (88b90ae) addresses both of @kentonv's review points well.
Verified
- Bug/feature routing separated (kentonv's first note). The
> [!IMPORTANT]block now sends bugs to [Issues] and feature requests/proposals to [Discussions] on separate lines. Both links resolve: Issues is the standardissues/new, and Discussions is enabled on the repo. - "Obviously correct" concern addressed (kentonv's second note re: the subtle one-line ollama change). The template no longer treats a small diff as sufficient:
- adds "obviously correct" alongside "trivially verifiable",
- frames acceptance as being "in the maintainers' assessment",
- removes the "about a dozen lines" line-count language,
- adds an explicit "Checking every item does not guarantee acceptance" note above the checklist, and
- the "Why is this obviously correct and trivially verifiable?" section asks the author to show the complete effects can be established by reading the patch — which is exactly the property the ollama example lacked.
This keeps the narrow exception (per dcartertwo's rationale) while making clear that maintainer judgment, not diff size, governs.
- Policy still faithful to
CONTRIBUTING.md.CONTRIBUTING.mdexists onmainand its "small, trivially-verified PRs" stance is preserved without overstating it. git diff --checkis clean — no whitespace issues.- Markdown well-formed. The
[!IMPORTANT]alert, section headers, and checklist render correctly; HTML comments precede the visible checklist text so thecontribution-policy:*markers stay hidden.
Note (non-blocking, unchanged from prior review)
- The hidden
contribution-policy:*identifiers are still currently unused. They remain a nice hook for future automation; worth a follow-up that actually consumes them, but not a blocker.
Looks good. The changes resolve the raised feedback.
|
Review posted to PR #144. SummaryThe head commit kentonv's feedback → resolution:
Verified: links resolve (CONTRIBUTING.md and Discussions both exist on |
Summary
Verification
git diff --check