Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This pull request addresses an ambiguity in the "Commits rules" section of the contributing guide, specifically in the description of commit message structure.
Problem:
The original text states:
This statement implies that the body is a mandatory part of a commit message, which is not accurate. In reality, the body is optional, and not all commits will require a body.
Solution:
The wording has been updated to:
This clarification ensures that contributors understand the body is not required for every commit and prevents confusion.
Importance:
Clarifying that the body is optional helps contributors avoid unnecessary commits with empty bodies. This improves the clarity and consistency of the commit history, which is especially important for automated changelog generation and code review processes.
Checklist
yarn test
without getting any errors