Skip to content
This repository was archived by the owner on Apr 1, 2025. It is now read-only.

Add language detailing policy re. PR approvals/change requests. #161

Merged
merged 3 commits into from
Jun 17, 2019
Merged

Add language detailing policy re. PR approvals/change requests. #161

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e60cf72
Add language detailing policy re. PR approvals/change requests.
Jun 17, 2019
fd2ba55
Address @dcreager's suggestions.
Jun 17, 2019
91c2b2b
Merge branch 'master' into please-dont-just-review-our-PRs
Jun 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

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.
Copy link
Contributor

@aymannadeem aymannadeem Jun 17, 2019

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


Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).

Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
Expand All @@ -28,6 +30,8 @@ Here are a few things you can do that will increase the likelihood of your pull
- 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.
Copy link
Contributor

@dcreager dcreager Jun 17, 2019

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:

Suggested change
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.


Please be aware that contributions to Semantic may multiple cycles of code review—we are grateful for all community involvement, but because Semantic powers real systems, we must maintain a high standard of code quality. For reasons of compatibility with production uses of Semantic within GitHub, we may also reject or require modifications to changes that would affect these systems. We may also reject patches that don't fit with our vision of the project; should this be the case, we will be clear about our rationale.

## Resources
Expand Down