Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: ensure collaborators validate commits #16162

Closed
wants to merge 3 commits into from
Closed

doc: ensure collaborators validate commits #16162

wants to merge 3 commits into from

Conversation

bmeck
Copy link
Member

@bmeck bmeck commented Oct 12, 2017 •
edited
Loading

This should be done every time a collaborator pushes a commit.

Checklist
Affected core subsystem(s)

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 12, 2017
joyeecheung
joyeecheung approved these changes Oct 12, 2017
View reviewed changes
Copy link
Member

@joyeecheung joyeecheung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a few suggestions

COLLABORATOR_GUIDE.md Outdated
@@ -515,6 +515,12 @@ Run tests (`make -j4 test` or `vcbuild test`). Even though there was a
successful continuous integration run, other changes may have landed on master
since then, so running the tests one last time locally is a good practice.

Validate that the commit message is properly formatted using [core-validate-commit](https://github.com/evanlucas/core-validate-commit).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: please wrap this into 80 characters per line

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

COLLABORATOR_GUIDE.md Outdated
Validate that the commit message is properly formatted using [core-validate-commit](https://github.com/evanlucas/core-validate-commit).

```text
$ core-validate-commit
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

core-validate-commit is also capable of validating multiple commits. Maybe

# Validate the HEAD commit
$ core-validate-commit

# Validate a single sha:
$ core-validate-commit 64c87e2

# Validate from a specific sha to HEAD:
$ git rev-list 287bdab..HEAD | xargs core-validate-commit

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be done after the rebase so they should only need to validate head, right?

Copy link
Member

@joyeecheung joyeecheung Oct 12, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bmeck If the person doing this is landing multiple commits, then they should validate all of them. Most of the times we are squashing all commits into one but there are times when a PR needs to be landed as multiple commits (and it's easier to forget to add metadata to the commits between the two heads, I would say)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

bmeck added 3 commits October 12, 2017 12:26
@bmeck
doc: ensure collaborators validate commits
bf3d990 
This should be done every time a collaborator pushes a commit.
@bmeck
nit 80 col
94ca2e4
@bmeck
xargs commits
2da60dc
@bmeck bmeck force-pushed the validate-in-collab-guide branch from 7e022d2 to 2da60dc Compare October 12, 2017 17:28
tniessen
tniessen approved these changes Oct 12, 2017
View reviewed changes
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could make the phrasing in onboarding.md a bit stricter as well, I believe it currently just suggests using core-validate-commit instead of requiring / strongly recommending it.

mhdawson
mhdawson approved these changes Oct 13, 2017
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, good idea.

jasnell pushed a commit that referenced this pull request Oct 13, 2017
@bmeck @jasnell
doc: ensure collaborators validate commits
eb3fee1 
This should be done every time a collaborator pushes a commit.

PR-URL: #16162
Reviewed-By: Joyee Cheung <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
@jasnell
Copy link
Member

jasnell commented Oct 13, 2017

Landed in eb3fee1

@jasnell jasnell closed this Oct 13, 2017
addaleax pushed a commit to ayojs/ayo that referenced this pull request Oct 15, 2017
@bmeck @addaleax
doc: ensure collaborators validate commits
a218fee 
This should be done every time a collaborator pushes a commit.

PR-URL: nodejs/node#16162
Reviewed-By: Joyee Cheung <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
targos pushed a commit that referenced this pull request Oct 18, 2017
@bmeck @targos
doc: ensure collaborators validate commits
4ed78e2 
This should be done every time a collaborator pushes a commit.

PR-URL: #16162
Reviewed-By: Joyee Cheung <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
MylesBorins pushed a commit that referenced this pull request Nov 16, 2017
@bmeck @MylesBorins
doc: ensure collaborators validate commits
92e7ca1 
This should be done every time a collaborator pushes a commit.

PR-URL: #16162
Reviewed-By: Joyee Cheung <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Nov 21, 2017
Merged
MylesBorins pushed a commit that referenced this pull request Nov 21, 2017
@bmeck @MylesBorins
doc: ensure collaborators validate commits
27274c7 
This should be done every time a collaborator pushes a commit.

PR-URL: #16162
Reviewed-By: Joyee Cheung <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
MylesBorins pushed a commit that referenced this pull request Nov 28, 2017
@bmeck @MylesBorins
doc: ensure collaborators validate commits
2515cad 
This should be done every time a collaborator pushes a commit.

PR-URL: #16162
Reviewed-By: Joyee Cheung <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joyeecheung joyeecheung joyeecheung approved these changes

@gibfahn gibfahn gibfahn approved these changes

@mhdawson mhdawson mhdawson approved these changes

@tniessen tniessen tniessen approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@Fishrock123 Fishrock123 Fishrock123 approved these changes

@addaleax addaleax addaleax approved these changes

@evanlucas evanlucas evanlucas approved these changes

@jasnell jasnell jasnell approved these changes

@silverwind silverwind silverwind approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.