Skip to content

Update CONTRIBUTING.md #29

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.

Sign up for GitHub

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

Closed
Ashusf90 wants to merge 1 commit into from
+33 −0
Closed

Update CONTRIBUTING.md #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,3 +317,36 @@ Do not open public issues for security vulnerabilities. Follow [SECURITY.md](SEC
## Code of conduct

All contributors are expected to follow [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
## 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
Comment on lines +349 to +352
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Loading