docs: fix grammar in CONTRIBUTING.md#370
Open
singhankit001 wants to merge 1 commit intokkrishguptaa:mainfrom
Open
docs: fix grammar in CONTRIBUTING.md#370singhankit001 wants to merge 1 commit intokkrishguptaa:mainfrom
singhankit001 wants to merge 1 commit intokkrishguptaa:mainfrom
Conversation
📝 WalkthroughWalkthroughA single grammar correction was made to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~1 minute Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
26-26:⚠️ Potential issue | 🟡 MinorFix incorrect fork link in contribution instructions.
The fork link on line 26 points to
https://github.com/krshoss/gardevoir/forkinstead of the correct repository. This will cause contributors to fork the wrong project.Fix
-**1.** Fork the repository. Click on the [](https://github.com/krshoss/gardevoir/fork) symbol at the top right corner. +**1.** Fork the repository. Click on the [](https://github.com/kkrishguptaa/reseter.css/fork) symbol at the top right corner.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 26, Replace the incorrect hard-coded fork URL in the Markdown line starting with "**1.** Fork the repository. Click on the [![Fork this repo]..." so the link points to this repository's actual GitHub fork URL (i.e., update the href inside the parentheses to the correct https://github.com/<correct-owner>/<correct-repo>/fork), verify the badge image remains unchanged, and test the link to ensure it opens the repository's fork page.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
7-7: Consider clarifying the opening phrase."Since the new GitHub Issue forms" is grammatically incomplete. Consider rewording for clarity.
✍️ Suggested improvements
-Since the new GitHub Issue forms, we only suggest you include the most information possible. But you can also **Perform a [cursory search](../../../issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +With the new GitHub Issue forms, we suggest you include as much information as possible. You should also **perform a [cursory search](../../../issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 7, The opening phrase "Since the new GitHub Issue forms" is grammatically incomplete; update the sentence in CONTRIBUTING.md to use a complete clause such as "With the introduction of the new GitHub Issue forms, we recommend that you include as much information as possible." Replace the fragment at the start of the sentence and ensure the rest of the sentence flows grammatically (e.g., keep the suggestion to perform a cursory search and the instruction to comment on existing issues).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 5: Standardize spelling in the CONTRIBUTING text by replacing the British
"behaviour" in the sentence "This section guides you through submitting a bug
report. Following these guidelines helps maintainers and the community
understand your report 📝, reproduce the behaviour 💻 💻, and find related
reports. 🔎" with the American "behavior" so the document consistently uses
American English (matches other occurrences of "behavior"); update any other
instances if present.
---
Outside diff comments:
In `@CONTRIBUTING.md`:
- Line 26: Replace the incorrect hard-coded fork URL in the Markdown line
starting with "**1.** Fork the repository. Click on the [![Fork this repo]..."
so the link points to this repository's actual GitHub fork URL (i.e., update the
href inside the parentheses to the correct
https://github.com/<correct-owner>/<correct-repo>/fork), verify the badge image
remains unchanged, and test the link to ensure it opens the repository's fork
page.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 7: The opening phrase "Since the new GitHub Issue forms" is grammatically
incomplete; update the sentence in CONTRIBUTING.md to use a complete clause such
as "With the introduction of the new GitHub Issue forms, we recommend that you
include as much information as possible." Replace the fragment at the start of
the sentence and ensure the rest of the sentence flows grammatically (e.g., keep
the suggestion to perform a cursory search and the instruction to comment on
existing issues).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| @@ -4,7 +4,7 @@ | |||
|
|
|||
| This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behaviour 💻 💻, and find related reports. 🔎 | |||
There was a problem hiding this comment.
Inconsistent spelling: "behaviour" vs "behavior".
Line 5 uses British spelling ("behaviour"), while lines 20–21 use American spelling ("behavior"). Documentation should maintain consistent spelling throughout. Consider standardizing to American English, which is more common in technical documentation.
📝 Proposed fix for consistency
-This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behaviour 💻 💻, and find related reports. 🔎
+This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports. 🔎📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behaviour 💻 💻, and find related reports. 🔎 | |
| This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports. 🔎 |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` at line 5, Standardize spelling in the CONTRIBUTING text by
replacing the British "behaviour" in the sentence "This section guides you
through submitting a bug report. Following these guidelines helps maintainers
and the community understand your report 📝, reproduce the behaviour 💻 💻, and
find related reports. 🔎" with the American "behavior" so the document
consistently uses American English (matches other occurrences of "behavior");
update any other instances if present.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Changed 'adds' to 'add' for correct subject-verb agreement.
Summary by CodeRabbit