Skip to content

doc: clarify expectations for PR commit messages #30922

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

Closed
DerekNonGeneric wants to merge 1 commit into from
Closed

doc: clarify expectations for PR commit messages #30922

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: clarify expectations for PR commit messages 
Prior to this commit, new contributors were suggested
to use a utility to validate commit messages. Although
not inaccurate, this utility produces misleading results.

* Remove reference to `core-validate-commit`
  • Loading branch information
Derek Lewis committed Dec 12, 2019
commit 4242fbada08e0f93817e848d7a87ba32911ecd3d
3 changes: 0 additions & 3 deletions doc/guides/contributing/pull-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,6 @@ One of the existing contributors will help get things situated and the
contributor landing the Pull Request will ensure that everything follows
the project guidelines.

See [core-validate-commit](https://github.com/nodejs/core-validate-commit) -
A utility that ensures commits follow the commit formatting guidelines.

Comment on lines -195 to -197

@richardlau richardlau Dec 13, 2019 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If we want to keep a reference to core-validate-commit then we should instruct to run with --no-validate-metadata as we do in Travis for pull requests.

node/tools/lint-pr-commit-message.sh

Line 38 in 357a992

npx -q core-validate-commit --no-validate-metadata "${FIRST_COMMIT}"

@DerekNonGeneric DerekNonGeneric Dec 13, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Would it make sense to set up a make task (phony target) specifically for this scenario?

@sam-github sam-github Dec 13, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ideally, the make test target should include a commit tester... though I suspect there are some complications, like only linting the new commit messages, not every one in the history of node.js,and perhaps dealing with fixup commits, etc.

@DerekNonGeneric DerekNonGeneric Dec 13, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@sam-github, are you saying that this check should take place when running the command mentioned in Step 6: Test? If so, simply validating the most recent commit should be all that is necessary as prior commits can be safely assumed to be valid (having already landed in upstream master). It's probably important to keep this discussion within the scope of ensuring a successful process for those following this guide.

### Step 5: Rebase

As a best practice, once you have committed your changes, it is a good idea
Expand Down