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.

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

Add clarification for description formatting #573

Open
echasnovski opened this issue Feb 27, 2024 · 0 comments
Open

Add clarification for description formatting #573

echasnovski opened this issue Feb 27, 2024 · 0 comments

Comments

@echasnovski
Copy link

Currently the only rule for description is "A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.".

Besides "be short", there is no specification on its formatting. I would like to suggest expanding this with (at least) two rules which are already followed in all examples and most real world usages:

  • First word MUST NOT be capitalized.
  • MUST NOT end with punctuation.

If any of this is a welcome change, I am happy to do a PR.

@echasnovski echasnovski changed the title Add dlarification for description formatting Add clarification for description formatting Feb 27, 2024
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

No branches or pull requests

1 participant