Skip to content

Commit

Permalink
Docs: Clarified PR guidelines in maintainer guide (#8876)
Browse files Browse the repository at this point in the history
  • Loading branch information
platinumazure authored and not-an-aardvark committed Jul 7, 2017
1 parent d1fc408 commit 7c8de92
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/maintainer-guide/pullrequests.md
Expand Up @@ -11,14 +11,14 @@ Anyone, both team members and the public, may leave comments on pull requests.
When a pull request is opened, the bot will check the following:

1. Has the submitter signed a CLA?
1. Is the commit message summary in the correct format? Double-check that the tag ("Fix:", "New:", etc.) is correct based on the issue. Documentation-only pull requests do not require an issue.
1. Does the commit summary reference an issue?
1. Is the commit message summary in the correct format?
1. Is the commit summary too long?

The bot will add a comment specifying the problems that it finds. You do not need to look at the pull request any further until those problems have been addressed (there's no need to comment on the pull request to ask the submitter to do what the bot asked - that's why we have the bot!).

Once the bot checks have been satisfied, you check the following:

1. Double-check that the commit message tag ("Fix:", "New:", etc.) is correct based on the issue (or, if no issue is referenced, based on the stated problem).
1. Does the code follow our conventions (including header comments, JSDoc comments, etc.)? If not, please leave that feedback and reference the conventions document.
1. For code changes:
* Are there tests that verify the change? If not, please ask for them.
Expand All @@ -38,6 +38,7 @@ Committers may merge a pull request if it is a non-breaking change and is:
1. A bug fix (for either rules or core)
1. A dependency upgrade
1. Related to the build system
1. A chore

In addition, committers may merge any non-breaking pull request if it has been approved by at least one TSC member.

Expand Down

0 comments on commit 7c8de92

Please sign in to comment.