-
Notifications
You must be signed in to change notification settings - Fork 459
Add language detailing policy re. PR approvals/change requests. #161
Conversation
We've seen some members of the public come in and leave distracting reviews on our pull requests. This patch adds a clause to our contributing documentation that outlines why we don't want people to continue doing this.
| - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. | ||
| - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). | ||
|
|
||
| Unless you are a member of the Semantic team or a code owner, we ask that you refrain from leaving approvals or change requests on in-progress pull requests, as spurious reviews make it difficult to discern which patches are truly ready for integration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should go up in the top-level Contributing section, not here. This section is about submitting a PR, which we definitely want anyone and everyone to feel comfortable doing!
How about the following as a new ¶ 2:
| Unless you are a member of the Semantic team or a code owner, we ask that you refrain from leaving approvals or change requests on in-progress pull requests, as spurious reviews make it difficult to discern which patches are truly ready for integration. | |
| We're happy to accept code and documentation contributions. And please feel free to open issues suggesting new features, asking questions about how things work, or generally about what we're trying to accomplish! **However**, we are not opening up the code review process to the public. PRs should _only_ be reviewed by one of the project maintainers. Therefore, we ask that you refrain from leaving approvals or change requests on in-progress pull requests, as spurious reviews make it difficult to discern which patches are truly ready for integration. |
|
|
||
| Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. | ||
|
|
||
| We're happy to accept code and documentation contributions, as well as issues suggesting new features, asking questions about how things work, or generally about what we're trying to accomplish! However, we are not opening up the code review process to the public. PRs should _only_ be reviewed by one of the project maintainers. Therefore, we ask that you refrain from leaving approvals or change requests on in-progress pull requests, as spurious reviews make it difficult to discern which patches are truly ready for integration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if this would sound too terse, but having a small heading "Code review process is not open to the public" might boost the signal
aymannadeem
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm barring @dcreager's suggestions!
We've seen some members of the public come in and leave distracting
reviews on our pull requests. This patch adds a clause to our
contributing documentation that outlines why we don't want people to
continue doing this.