You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The reason will be displayed to describe this comment to others. Learn more.
Yep, sometimes commits land without the appropriate PR metadata. It happens. When it does (and someone catches it) the usual approach is to add a comment in the commit itself that points out the issue.
The reason for the full PR-URL is that our release tools use the full URL to build out a proper changelog. Without the appropriate metadata the releaser has to go chase things down which is annoying.
The reason will be displayed to describe this comment to others. Learn more.
@jasnell I added a PR to help with the docs around this: #5661
Do you know if there is a way to lint commit messages, this would be a better solution going forward. Especially with my mistake around not adding an extra newline on the title -> body :/
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that this commit does not include full PR-URL, it has:
while it's supposed to be:
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also the commit message is too long. Max of 50 chars. Rest should be placed in the commit message body.
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I appreciate the feedback.
If the full URL is so important, shouldn't we be using it for release commits as well: 7b0a83d ?
Is it Ref or Refs, I see it both ways in our commits?
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, sometimes commits land without the appropriate PR metadata. It happens. When it does (and someone catches it) the usual approach is to add a comment in the commit itself that points out the issue.
The reason for the full PR-URL is that our release tools use the full URL to build out a proper changelog. Without the appropriate metadata the releaser has to go chase things down which is annoying.
FWIW, The style guide for commits is already documented in the CONTRIBUTING.md doc: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jasnell thanks, I will update the collaborator guide to refer to it.
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jasnell I added a PR to help with the docs around this: #5661
Do you know if there is a way to lint commit messages, this would be a better solution going forward. Especially with my mistake around not adding an extra newline on the title -> body :/
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@geek I'm researching into how we could do that with a git hook
--> https://github.com/mozilla/fjord/blob/master/bin/hooks/lint.commit-msg
--> https://git-scm.com/book/en/v2/Customizing-Git-An-Example-Git-Enforced-Policy
7d3a7ea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I started on a commit linter tool but haven't had any time to finish it up. I'll be trying to get back to it here in the next week or two.