docs(collaborator_guide): add collaborator guide #3724
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
This adds a collaborator guide that describes how to reply to issues and PRs and how to accept changes to the project.
heff
approved these changes
Oct 28, 2016
|
|
||
| Before merging the change, it should be left open for other core committers to comment on. At least 24 hours during a weekday, and the 48 hours on a weekend. Trivial changes or bug fixes that have been reviewed by multiple committers may be merged without delay. | ||
|
|
||
| For non-breaking changes, if there is no disagreeming between the collaborators, the PR may be landed assuming it was reviewed. If there is still disagreement, it may need to be [escalated to the TSC](#involving-the-tsc). |
|
|
||
| Collaborators may manage issues they feel qualified to handle, being mindful of our guidelines. | ||
|
|
||
| Any issue and PR can be closed if they are not relevant, when in doubt leave it open for more discussion. Issues and always be re-opened if new information is made available. |
mister-ben
reviewed
Oct 28, 2016
|
|
||
| Landing a PR is fairly easy given that we can use the Github UI for it. | ||
|
|
||
| When using the big green button on github, make sure the "squash and merge" is selected -- it should be the only allowed option. If a PR has two features in it and should be merged as two separate commits, either ask the contributor to break it up into two, or follow the [manual steps](#langing-a-pr-manually). |
mister-ben
reviewed
Oct 28, 2016
|
|
||
| The commit message should follow our [conventional changelog conventions][conventions]. They are based on the angularjs changelog conventions. The changelog is then generated from these commit messages on release. | ||
|
|
||
| The first line of the commit message -- the header and first text box on github -- should be prefixed with a type and optional scope followed by a short description of the commit. |
There was a problem hiding this comment.
Minor niggle, but the capitalisation of 'Github' is inconsistent
gkatsev
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds a collaborator guide that describes how to reply to issues and
PRs and how to accept changes to the project.