Skip to content

Put commit hygeine instructions in review prompt#12

Open
squaremo wants to merge 1 commit into
mainfrom
rid-us-all-of-awful-commit-messages
Open

Put commit hygeine instructions in review prompt#12
squaremo wants to merge 1 commit into
mainfrom
rid-us-all-of-awful-commit-messages

Conversation

@squaremo

Copy link
Copy Markdown
Contributor

In an attempt to get consistency with commit messages, I've put some instructions here. These are a summary of https://cbea.ms/git-commit/.

Note that "conventional commit" is explicitly excluded. It's no good having them sprinkled through the git history; and if I have to choose, I choose to omit the noise of those prefixes. They are not used in these repos, and I'd argue would not be usable (since they are often on commits that are squashed anyway, aren't always accurate, and take up space that could be a more thoughtful commit message.)

In an attempt to get consistency with commit messages, I've put some
instructions here. These are a summary of https://cbea.ms/git-commit/.

Note that "conventional commit" is explicitly excluded. It's no good
having them sprinkled through the git history; and if I have to
choose, I choose to omit the noise of those prefixes. They are not
used in these repos, and I'd argue would not be usable (since they are
often on commits that are squashed anyway, aren't always accurate, and
take up space that could be a more thoughtful commit message.)
@squaremo

Copy link
Copy Markdown
Contributor Author

From https://github.com/nscaledev/uni-shared-workflow-tester/pull/6#issuecomment-4557030669

Does the commit message follow the standards? No. Critical violations:

❌ The subject line uses "feat(readme):" which is a conventional commit prefix (explicitly forbidden)
❌ The subject line is 46 characters, which is acceptable (under the 50 character limit)
✅ The subject is in imperative mood ("token instructions are updated")
✅ The body is well-wrapped and provides clear context

Well you know. One out of four ain't bad.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant