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

Update CONTRIBUTING.md #2334

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

vadimka14
Copy link

@vadimka14 vadimka14 commented Sep 26, 2024

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 review


PR-Codex overview

This PR focuses on improving the clarity and consistency of the CONTRIBUTING.md documentation by correcting punctuation and formatting issues.

Detailed summary

  • Updated section headers for consistency (e.g., added period after "Writing Docs").
  • Added periods at the end of several guidelines for uniformity.
  • Clarified the steps for running yarn changeset.
  • Enhanced the instructions for publishing versions with clearer formatting.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

add a dot where it is missing
Copy link

changeset-bot bot commented Sep 26, 2024

⚠️ No Changeset found

Latest commit: 55b8c02

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Sep 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hub-monorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 26, 2024 2:59pm

@@ -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
Copy link
Member

@sds sds Sep 26, 2024

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:

  1. 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.
  2. 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.

Copy link
Author

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

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.

2 participants