diff options
| author | Austin S. Hemmelgarn <austin@netdata.cloud> | 2020-11-30 07:03:47 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-30 07:03:47 -0500 |
| commit | 0d0e7dad5f62bb9bcec194a4e6c0b6cc0c7bc51d (patch) | |
| tree | 0b0927db8738dd182b6bd9a28b3d2bd8f0f15c93 /CONTRIBUTING.md | |
| parent | cd4340321dbf0ea98b3a5dfdf5746360ba217e4b (diff) | |
Updated contributing guidelines to suggest use of Draft PRs. (#10125)
* Updated contributing guidelines to suggest use of Draft PRs.
This also removes mention of the WIP check that we are planning to stop
using and corrects a grammar error in a nearby sentence.
* Tidy-up MD syntax.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1cf142490..b9e4418ab6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -232,10 +232,10 @@ The body of the commit message should be a short description of the work, prefer ### PR approval process -Each PR automatically [requires a review](https://help.github.com/articles/about-required-reviews-for-pull-requests/) from the code owners specified in `.github/CODEOWNERS`. Depending on the files contained in your PR, several people may be need to approve it. +Each PR automatically [requires a review](https://help.github.com/articles/about-required-reviews-for-pull-requests/) from the code owners specified in `.github/CODEOWNERS`. Depending on the files contained in your PR, several people may be needed to approve it. We also have a series of automated checks running, such as linters to check code quality and QA tests. If you get an error or warning in any of those checks, you will need to click on the link included in the check to identify the root cause, so you can fix it. -One special type of automated check is the "WIP" check. You may add "[WIP]" to the title of the PR, to tell us that the particular request is "Work In Progress" and should not be merged. You're still not done with it, you created it to get some feedback. When you're ready to get the final approvals and get it merged, just remove the "[WIP]" string from the title of your PR and the "WIP" check will pass. +If you wish to open a PR but are not quite ready for the code to be reviewed, you can open it as a Draft PR (click the dropdown on the **Create PR** button and select **Draft PR**). This will prevent reviewers from being notified initially so that you can keep working on the PR. Once you're ready, you can click the **Ready for Review** button near the bottom of the PR to mark it ready and notify the relevant reviewers. [](<>) |