-
Notifications
You must be signed in to change notification settings - Fork 392
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
Update CONTRIBUTING.md #2334
base: main
Are you sure you want to change the base?
Update CONTRIBUTING.md #2334
Conversation
add a dot where it is missing
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@@ -103,7 +103,7 @@ All changes that involve features or bugfixes should be accompanied by tests, an | |||
- Tests should use [factories](https://github.com/thoughtbot/fishery) instead of stubs wherever possible. | |||
- Critical code paths should have 100% test coverage, which you can check in the Coveralls CI. | |||
|
|||
### 3.2 Writing Docs | |||
### 3.2. Writing Docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Header numberings don't end with a period. From ChatGPT:
- Clarity and Consistency: The period in “3.2” is already separating the section number from the subsection. Adding another period at the end (i.e., “3.2.”) could cause confusion, as it is redundant and unnecessary.
- Style Guides: Common style guides, such as the Chicago Manual of Style and APA, recommend numbering headers without a trailing period unless it serves a specific purpose (e.g., in some legal or technical documents, though even these often omit the extra period).
In most cases, “3.2” without the trailing period is the correct and preferred format.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
then why "3.1." and "3.3." is with dot. Then i`ll make new commit
add a dot where it is missing
Why is this change needed?
you need to follow the culture of writing
Merge Checklist
Choose all relevant options below by adding an
x
now or at any time before submitting for reviewPR-Codex overview
This PR focuses on improving the clarity and consistency of the
CONTRIBUTING.md
documentation by correcting punctuation and formatting issues.Detailed summary
yarn changeset
.