Skip to content

doc: clarify expectations for PR commit messages

Rodrigo Muino Tomonari requested to merge github/fork/DerekNonGeneric/disambig-contrib-pr into master

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
Checklist

The last line in section Step 4: Commit of the Contributing Pull Requests guide suggests using a utility to validate commit messages, namely core-validate-commit. The following is what results when running the tool against a commit that has followed the guide (and even went too far by adding its PR-URL).

disambig

As can be seen in the snip above, the utility produces misleading results that may inadvertently lead new contributors to think that they, themselves are required to include this metadata in their PR's commit message when in reality, omitting this metadata will not cause the CI checks to fail. See how this leads to the confusion experienced here: https://github.com/nodejs/node/pull/30216#issuecomment-565170460.

Although this PR is removing reference to this tool entirely from this document, I hope that it leads to a constructive discussion about a preferred way of making this clarification (if it is deemed that this is not ideal).

/cc @MylesBorins

Merge request reports