Add guidance for PRs opened ahead of an issue#11488
Conversation
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for 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 adds documentation to CONTRIBUTING.md explaining what contributors should do when they open a PR before the normal linked-issue workflow is complete.
Concerns
- No blocking concerns found. The added guidance is documentation-only, the referenced anchors exist, no approved spec context applies, and the security pass found no security-sensitive changes.
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
vkodithala
left a comment
vkodithala
left a comment
There was a problem hiding this comment.
Thank you SO MUCH for making this, there are a few things I'd like us to verify. I'm starting to see that the oz-for-oss flow may be confusing, so maybe a step after this would be codifying it somewhere more convenient.
| That said, if you open a PR ahead of the standard issue workflow, here's what to do: | ||
|
|
||
| 1. **Search for a related issue.** Due to the volume of issues we receive, there's often an existing issue for a given feature or bug fix. If you find one, link it in your PR description. Ideally, this issue will have been reviewed by a maintainer with a [readiness label](#readiness-labels) applied. If you do not find a related issue, file an issue describing what your PR resolves. For especially trivial bug fixes, you can proceed without an issue. Just note your reasoning in the PR description. | ||
| 2. **Ensure your PR passes code review and includes relevant tests** per our [Opening a Code PR guide.](#opening-a-code-pr) |
There was a problem hiding this comment.
So, Oz code review doesn't actually run in earnest until an issue is linked. I wonder if we can just skip this second bullet altogether, since this is probably covered by other sections?
There was a problem hiding this comment.
My thinking is that we're going to link to this section when this occurs in the future, and I want to be especially clear that they should read the "opening a code PR" section. Otherwise, they'll skim this section and avoid reading the rest of the doc :)
|
I'm re-reviewing this pull request in response to a review request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
Co-authored-by: Varoon Kodithala <varoon@warp.dev>
There was a problem hiding this comment.
Overview
This documentation-only PR adds guidance to CONTRIBUTING.md for contributors who open a PR before the usual linked-issue workflow is complete.
Concerns
- No blocking concerns found. The attached spec context contains no approved spec commitments to validate against, and the diff does not introduce security-sensitive behavior.
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
2 participants
Description
Adds guidance to
CONTRIBUTING.mdfor contributors who open a PR before the usual linked-issue workflow is complete.For reference, I have had two community members ask about Warp features on X, and each of them have jumped to a working solution after encouragement to contribute (ex 1, ex 2). We should communicate better when inviting on the DevEx side by linking to the contributing guide directly. However, for users that do build out features that are ready to PR without the standard issue -> triage ->
ready-to-implementflow, we should have some guidance on what to do with their work.The new section explains that PRs should generally start from an issue discussion, then outlines what to do if a PR is opened ahead of that flow:
Linked Issue
No linked issue; this is a documentation-only clarification.
ready-to-specorready-to-implement.Testing
Documentation-only change; no automated tests run.
./script/runAgent Mode
CHANGELOG-NONE
Co-Authored-By: Oz oz-agent@warp.dev