Update CONTRIBUTING.md#29
Closed
Ashusf90 wants to merge 1 commit into
Closed
Conversation
📝 WalkthroughWalkthroughThis pull request adds a new documentation section to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 2/3 reviews remaining, refill in 20 minutes. Comment Warning |
|
This pull request needs a small update before review:
|
github-actions
Bot
added
needs: title
github-actions
Bot
added
needs: compliance
![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)
320-353:⚠️ Potential issue | 🟡 MinorThis section doesn’t match the stated PR-template objective.
The added content is an example PR description, but it does not provide the reusable template structure described in this PR’s objective (Summary, Linked context, Checklist, Notes for reviewers). Please replace this example block with an actual template contributors can copy directly.
Suggested replacement
-## Example: First Pull Request (Docs Change) - -Below is a sample pull request description for a small documentation update. - ---- - -### Title -docs: improve contributing guide with clarification on setup steps (`#XX`) - ---- - -### Summary -This PR improves the contributing documentation by clarifying the project setup steps for new contributors. - ---- - -### Linked Issue -Closes `#XX` - ---- - -### Changes -- Updated setup instructions in `CONTRIBUTING.md` -- Fixed minor wording issues for clarity -- Improved formatting for readability - ---- - -### Verification -Run the following command to ensure formatting is correct: - -```bash -pnpm format:prettier:check -``` +## Pull request template + +### Summary +Describe what changed and what outcome this creates for users/maintainers. + +### Linked context +- Closes #... +- Related to #... +- Supersedes #... + +### Checklist +- [ ] I ran relevant local checks. +- [ ] I updated docs if behavior or workflow changed. +- [ ] I linked related issues/PRs. +- [ ] This PR is scoped to one clear objective. +- [ ] I confirm this PR is human-authored and follows repo authorship policy. + +### Notes for reviewers +Call out tradeoffs, follow-up work, or setup needed to validate this change.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` around lines 320 - 353, Replace the example PR description block under "Example: First Pull Request (Docs Change)" with a reusable, copyable PR template titled "Pull request template" that includes the headings "Summary", "Linked context", "Checklist", and "Notes for reviewers"; remove the broken/trailing code fence and stray shell snippet and ensure the "Verification" step shows the correct formatted command (pnpm format:prettier:check) as a code block; make the template content match the suggested replacement sections and checklist items so contributors can copy-paste directly.
🤖 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`:
- Around line 349-352: Replace the non-canonical docs formatting command string
"pnpm format:prettier:check" with the canonical docs-only command "pnpm
format:check" so the CONTRIBUTING.md uses a single consistent formatting
command; update the occurrence in the paragraph that currently reads "Run the
following command to ensure formatting is correct:" and ensure any example block
or inline mention matches the "pnpm format:check" token.
---
Outside diff comments:
In `@CONTRIBUTING.md`:
- Around line 320-353: Replace the example PR description block under "Example:
First Pull Request (Docs Change)" with a reusable, copyable PR template titled
"Pull request template" that includes the headings "Summary", "Linked context",
"Checklist", and "Notes for reviewers"; remove the broken/trailing code fence
and stray shell snippet and ensure the "Verification" step shows the correct
formatted command (pnpm format:prettier:check) as a code block; make the
template content match the suggested replacement sections and checklist items so
contributors can copy-paste directly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+349
to
+352
| Run the following command to ensure formatting is correct: | ||
|
|
||
| ```bash | ||
| pnpm format:prettier:check |
There was a problem hiding this comment.
Use the same docs-formatting command already documented above.
Line 352 uses pnpm format:prettier:check, while the canonical docs-only command in this file is pnpm format:check (Line 233). Keep one command to avoid contributor confusion.
Suggested fix
-Run the following command to ensure formatting is correct:
+Run the following command to ensure formatting is correct:
```bash
-pnpm format:prettier:check
+pnpm format:check</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **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.
```suggestion
Run the following command to ensure formatting is correct:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 349 - 352, Replace the non-canonical docs
formatting command string "pnpm format:prettier:check" with the canonical
docs-only command "pnpm format:check" so the CONTRIBUTING.md uses a single
consistent formatting command; update the occurrence in the paragraph that
currently reads "Run the following command to ensure formatting is correct:" and
ensure any example block or inline mention matches the "pnpm format:check"
token.
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
2 participants
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.
Pull Request
Summary
Describe the change and the user or maintainer outcome.
Linked context
Closes # or Related to # or Supersedes #
Checklist
Notes for reviewers
Call out any tradeoffs, follow-up work, or setup needed to validate the change.
Summary by CodeRabbit