docs: simplify PR template for public contributors#9270
Conversation
Remove internal-only sections (Server API dependencies references, stable changelog entries, internal Notion links) and add guidance asking authors to confirm the linked issue is labeled ready-to-spec or ready-to-implement and to attach screenshots or a short video of the implementation where appropriate. Co-Authored-By: Oz <[email protected]>
|
I'm starting a first review of this pull request. You can follow along in the session on Warp. I completed the review and posted feedback on this pull request. Comment I completed the review and posted feedback on this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR simplifies the public pull request template by removing internal-only Notion/process sections and adding linked-issue plus screenshots/videos prompts for contributors.
Concerns
- No blocking concerns found.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
Restores the Changelog Entries for Stable section to the PR template, wrapped in an HTML comment so it remains hidden in the rendered PR description but available for contributors to fill in when needed. Co-Authored-By: Oz <[email protected]>
|
/oz-review |
1 similar comment
|
/oz-review |
There was a problem hiding this comment.
Overview
This PR simplifies .github/pull_request_template.md for public contributors by adding linked-issue and media sections, removing the server API dependency checklist, and trimming testing guidance.
Concerns
- The stable changelog section was hidden inside an HTML comment instead of being removed, so public contributors will still see the internal release-process text while editing the PR template.
- Security pass: no security-specific issues found in this documentation-only diff.
Verdict
Found: 0 critical, 1 important, 0 suggestions
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
## Description Simplifies the public-facing pull request template by removing internal-only sections and guiding contributors toward the issue-readiness workflow. Changes: - Removed the `Server API dependencies` section and its internal Notion links. - Removed the `Changelog Entries for Stable` section (internal release process). - Removed the testing-policy Notion link from the `Testing` section. - Added a `Linked Issue` section with checkboxes asking authors to confirm: - The linked issue is labeled `ready-to-spec` or `ready-to-implement`. - Screenshots or a short video of the implementation are included where appropriate. - Added a `Screenshots / Videos` section as a place to attach that media. ## Testing Documentation-only change; verified the rendered template via `git diff`. _Conversation: https://staging.warp.dev/conversation/7821ed8c-960f-406d-bec1-485a6c540873_ _Run: https://oz.staging.warp.dev/runs/019dd545-1271-74cb-81ad-2545e30fb1fc_ _This PR was generated with [Oz](https://warp.dev/oz)._ --------- Co-authored-by: Oz <[email protected]>
2 participants
Description
Simplifies the public-facing pull request template by removing internal-only sections and guiding contributors toward the issue-readiness workflow.
Changes:
Server API dependenciessection and its internal Notion links.Changelog Entries for Stablesection (internal release process).Testingsection.Linked Issuesection with checkboxes asking authors to confirm:ready-to-specorready-to-implement.Screenshots / Videossection as a place to attach that media.Testing
Documentation-only change; verified the rendered template via
git diff.Conversation: https://staging.warp.dev/conversation/7821ed8c-960f-406d-bec1-485a6c540873
Run: https://oz.staging.warp.dev/runs/019dd545-1271-74cb-81ad-2545e30fb1fc
This PR was generated with Oz.