Skip to content

✏️(docs) fix typos in contributing guide#2443

Open
ydnd wants to merge 1 commit into
suitenumerique:mainfrom
ydnd:docs-fix-contributing-typos
Open

✏️(docs) fix typos in contributing guide#2443
ydnd wants to merge 1 commit into
suitenumerique:mainfrom
ydnd:docs-fix-contributing-typos

Conversation

@ydnd

@ydnd ydnd commented Jun 19, 2026

Copy link
Copy Markdown

Correct minor wording and spelling mistakes in the contribution guidelines.

Purpose

Describe the purpose of this pull request.

Proposal

  • item 1...
  • item 2...

External contributions

Thank you for your contribution! 🎉

Please ensure the following items are checked before submitting your pull request:

General requirements

Skip the checkbox below 👇 if you're fixing an issue or adding documentation

  • Before submitting a PR for a new feature I made sure to contact the product manager

CI requirements

  • I made sure that all existing tests are passing
  • I have signed off my commits with git commit --signoff (DCO compliance)
  • I have signed my commits with my SSH or GPG key (git commit -S)
  • My commit messages follow the required format: <gitmoji>(type) title description
  • I have added a changelog entry under ## [Unreleased] section (if noticeable change)

AI requirements

Skip the checkboxes below 👇 If you didn't use AI for your contribution

  • I used AI assistance to produce part or all of this contribution
  • I have read, reviewed, understood and can explain the code I am submitting
  • I can jump in a call or a chat to explain my work to a maintainer

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0ce78e2b-5ba0-4172-afbc-6ea5ec10a6b1

📥 Commits

Reviewing files that changed from the base of the PR and between 16eb35b and a275e36.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Walkthrough

Four grammar and wording corrections are applied to CONTRIBUTING.md. The introduction changes "all kind of contributions" to "all kinds of contributions." A duplicated "use" is removed from the EPICs coordination sentence. The CI requirements bullet for running tests is reworded to "all required tests pass," replacing a malformed incomplete sentence. The AI-tools section fixes a duplicated "use us" phrase and replaces the misspelling "ankward" with "awkward."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly summarizes the main change: fixing typos in the contributing guide documentation.
Description check ✅ Passed The description is related to the changeset, stating it corrects minor wording and spelling mistakes in contribution guidelines, which aligns with the actual fixes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AntoLC AntoLC added the typo label Jun 22, 2026
@AntoLC AntoLC self-requested a review June 22, 2026 07:27
@ydnd

ydnd commented Jun 22, 2026

Copy link
Copy Markdown
Author

Thanks for the approval!

I noticed the branch protection requires verified signatures. I signed off the commit for DCO compliance, but my local GPG/SSH signing is not configured yet.

Would you prefer me to re-sign the commit and force-push, or is squash merging by a maintainer acceptable here?

@ydnd ydnd force-pushed the docs-fix-contributing-typos branch from 59a0aac to 16eb35b Compare June 22, 2026 09:16
@ydnd

ydnd commented Jun 22, 2026

Copy link
Copy Markdown
Author

Thanks for the review. I have re-signed the commit and the signature requirement should now be resolved. Could you please approve the pending workflows when convenient?

@AntoLC

AntoLC commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Hi, you have to rebase from main instead.

image

Correct minor wording and spelling mistakes in the contribution guidelines.

Signed-off-by: ydnd <1843212188@qq.com>
@ydnd ydnd force-pushed the docs-fix-contributing-typos branch from 41012dd to a275e36 Compare June 23, 2026 08:39
@ydnd

ydnd commented Jun 23, 2026

Copy link
Copy Markdown
Author

Done, thanks! I rebased the branch on top of main and force-pushed the updated history.

@ydnd

ydnd commented Jun 23, 2026

Copy link
Copy Markdown
Author

This is a documentation typo-only change. Could you please add the noChangeLog label, or should I add a small changelog entry?

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants