Docs: Clarified PR guidelines in maintainer guide #8876
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@platinumazure, thanks for your PR! By analyzing the history of the files in this pull request, we identified @nzakas and @btmills to be potential reviewers. |
|
LGTM |
platinumazure
added
documentation
|
TSC Summary: Goal is to clarify and improve the PR guidelines in the maintainer guide. I tried to make changes that were either obvious clarifications/reorganizations, or that reflected our actual practices. Nonetheless, this might need TSC review to make sure I'm not inadvertently proposing to change maintainer guidelines. TSC Question: Are the proposed changes acceptable and accurate? |
kaicataldo
reviewed
Jul 5, 2017
| 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). |
There was a problem hiding this comment.
Can we add something like Note that documentation-only pull requests do not require an issue. to the end of this?
|
That's no longer accurate (or rather sufficient): we only require issues on
core changes now. I believe I included a note to that effect elsewhere in
the commit but I'll double check.
…On Jul 4, 2017 8:49 PM, "Kai Cataldo" ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/maintainer-guide/pullrequests.md
<#8876 (comment)>:
> 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).
Can we add something likeNote that documentation-only pull requests do
not require an issue. to the end of this?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#8876 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AARWejceI3Y-RP3_YeSD3wmaYvw5I1_kks5sKuuZgaJpZM4ONcSP>
.
|
|
Sorry - you're right. This LGTM! |
kaicataldo
approved these changes
Jul 5, 2017
not-an-aardvark
approved these changes
Jul 6, 2017
gyandeeps
approved these changes
Jul 6, 2017
btmills
added
accepted
|
These changes were accepted by the TSC in the 2017-07-06 meeting. |
btmills
approved these changes
Jul 6, 2017
not-an-aardvark
removed
the
tsc agenda
This was referenced Jul 9, 2017
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain: Modifying PR guidelines in maintainer guide
What changes did you make? (Give an overview)
In the PR guide for maintainers:
Is there anything you'd like reviewers to focus on?
I tried to make changes that were either obvious clarifications/reorganizations, or that reflected our actual practices. Nonetheless, this might need TSC review to make sure I'm not inadvertently proposing to change maintainer guidelines.