Create CONTRIBUTING.md with contribution guidelines #423
Conversation
Added a comprehensive guide for contributors outlining best practices, core principles, and a recommended workflow for making safe contributions to the project.
📝 WalkthroughWalkthroughA new CONTRIBUTING.md file has been added documenting contribution guidelines, including core principles for single-purpose PRs, AI-assisted workflows, recommended review cycles, PR description templates, and best practices for minimizing risk and ensuring review-friendly changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 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)
Tip We've launched Issue Planner and it is currently in beta. Please try it out and share your feedback on Discord! 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: 4
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Line 1: Change the phrase "Hopefully this will provide a simple, easy to
understand guide to making safe contributions to the project, happy coding!" by
hyphenating "easy-to-understand" so it reads "Hopefully this will provide a
simple, easy-to-understand guide to making safe contributions to the project,
happy coding!" — locate the exact sentence containing "simple, easy to
understand guide" and replace that substring with the hyphenated form.
- Line 70: Replace the incorrect product names in the sentence: change "Claud"
to "Claude" and "VScode" to "VS Code" so the line reads using the correct
capitalization and spelling; ensure any other occurrences of those exact tokens
("Claud", "VScode") in CONTRIBUTING.md are updated consistently and run a quick
spell/cap check to confirm "OpenAI codex" casing matches project style.
- Line 161: Update the sentence in CONTRIBUTING.md that reads “If you have
multiple Coderabbit/copilot responses to your PR, its probably a good idea to
revoke the PR, fix the issues raised by the review bot, and resubmit.” by
correcting the typo “its” to the contraction “it’s” and replacing the phrasing
“revoke the PR” with a clearer option such as “close the PR” (or “close it”), so
the revised line reads along the lines of “If you have multiple
Coderabbit/copilot responses to your PR, it’s probably a good idea to close the
PR, fix the issues raised by the review bot, and resubmit.”
- Line 9: Update the sentence in CONTRIBUTING.md to correct typos and
hyphenation: change “amature” to “amateur”, “semi professional” to
“semi‑professional”, and “none technical” to “non‑technical”, and tighten
phrasing (for example: “The project has gone viral and has thousands of
users—amateur, semi‑professional and professional, technical and
non‑technical—so Ace-Step needs reliable builds to maintain user trust and
engagement.”) Replace the original sentence with the corrected version.
| @@ -0,0 +1,175 @@ | |||
| Hopefully this will provide a simple, easy to understand guide to making safe contributions to the project, happy coding! | |||
There was a problem hiding this comment.
Hyphenate “easy-to-understand.”
Minor grammar polish.
Suggested edit
-Hopefully this will provide a simple, easy to understand guide to making safe contributions to the project, happy coding!
+Hopefully this will provide a simple, easy-to-understand guide to making safe contributions to the project, happy coding!📝 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.
| Hopefully this will provide a simple, easy to understand guide to making safe contributions to the project, happy coding! | |
| Hopefully this will provide a simple, easy-to-understand guide to making safe contributions to the project, happy coding! |
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: Use a hyphen to join words.
Context: ...pefully this will provide a simple, easy to understand guide to making safe contr...
(QB_NEW_EN_HYPHEN)
[grammar] ~1-~1: Use a hyphen to join words.
Context: ...ully this will provide a simple, easy to understand guide to making safe contribu...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` at line 1, Change the phrase "Hopefully this will provide a
simple, easy to understand guide to making safe contributions to the project,
happy coding!" by hyphenating "easy-to-understand" so it reads "Hopefully this
will provide a simple, easy-to-understand guide to making safe contributions to
the project, happy coding!" — locate the exact sentence containing "simple, easy
to understand guide" and replace that substring with the hyphenated form.
| This project supports **many hardware and runtime combinations**. | ||
| A change that works perfectly on one setup can unintentionally break another if scope is not tightly controlled. | ||
|
|
||
| The project has kind of gone viral, and has thousands of users, amature, semi professional and professional, technical and none technical, it is important that Ace-Step has reliable builds to maintain user trust and engagement. |
There was a problem hiding this comment.
Fix spelling and hyphenation in the user description sentence.
“amature” → “amateur”, “semi professional” → “semi-professional”, “none technical” → “non-technical”; also consider tightening the phrasing.
Suggested edit
-The project has kind of gone viral, and has thousands of users, amature, semi professional and professional, technical and none technical, it is important that Ace-Step has reliable builds to maintain user trust and engagement.
+The project has kind of gone viral, and has thousands of users, amateur, semi-professional and professional, technical and non-technical, so it is important that Ace-Step has reliable builds to maintain user trust and engagement.📝 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.
| The project has kind of gone viral, and has thousands of users, amature, semi professional and professional, technical and none technical, it is important that Ace-Step has reliable builds to maintain user trust and engagement. | |
| The project has kind of gone viral, and has thousands of users, amateur, semi-professional and professional, technical and non-technical, so it is important that Ace-Step has reliable builds to maintain user trust and engagement. |
🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider using a more formal alternative here.
Context: ...ot tightly controlled. The project has kind of gone viral, and has thousands of users,...
(KIND_OF_SORT_OF_FORMAL)
[grammar] ~9-~9: Ensure spelling is correct
Context: ...gone viral, and has thousands of users, amature, semi professional and professional, te...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~9-~9: Use a hyphen to join words.
Context: ...nd has thousands of users, amature, semi professional and professional, technical...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` at line 9, Update the sentence in CONTRIBUTING.md to correct
typos and hyphenation: change “amature” to “amateur”, “semi professional” to
“semi‑professional”, and “none technical” to “non‑technical”, and tighten
phrasing (for example: “The project has gone viral and has thousands of
users—amateur, semi‑professional and professional, technical and
non‑technical—so Ace-Step needs reliable builds to maintain user trust and
engagement.”) Replace the original sentence with the corrected version.
|
|
||
| **Use a different agent to review your work than was used to produce the work** | ||
|
|
||
| If you use Claud or OpenAI codex, use your free Copilot tokens in VScode to get a Copilot review. If in doubt, ask your main agent to formulate a prompt for the review agent. It will 'know' what it has worked on and can suggest appropriate focus areas for the review agent. |
There was a problem hiding this comment.
Correct product names and capitalization.
“Claud” should be “Claude” and “VScode” should be “VS Code”.
Suggested edit
-If you use Claud or OpenAI codex, use your free Copilot tokens in VScode to get a Copilot review. If in doubt, ask your main agent to formulate a prompt for the review agent. It will 'know' what it has worked on and can suggest appropriate focus areas for the review agent.
+If you use Claude or OpenAI Codex, use your free Copilot tokens in VS Code to get a Copilot review. If in doubt, ask your main agent to formulate a prompt for the review agent. It will 'know' what it has worked on and can suggest appropriate focus areas for the review agent.📝 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.
| If you use Claud or OpenAI codex, use your free Copilot tokens in VScode to get a Copilot review. If in doubt, ask your main agent to formulate a prompt for the review agent. It will 'know' what it has worked on and can suggest appropriate focus areas for the review agent. | |
| If you use Claude or OpenAI Codex, use your free Copilot tokens in VS Code to get a Copilot review. If in doubt, ask your main agent to formulate a prompt for the review agent. It will 'know' what it has worked on and can suggest appropriate focus areas for the review agent. |
🧰 Tools
🪛 LanguageTool
[grammar] ~70-~70: Ensure spelling is correct
Context: ... codex, use your free Copilot tokens in VScode to get a Copilot review. If in doubt, a...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` at line 70, Replace the incorrect product names in the
sentence: change "Claud" to "Claude" and "VScode" to "VS Code" so the line reads
using the correct capitalization and spelling; ensure any other occurrences of
those exact tokens ("Claud", "VScode") in CONTRIBUTING.md are updated
consistently and run a quick spell/cap check to confirm "OpenAI codex" casing
matches project style.
| - Known pre-existing issues not addressed | ||
| - Follow-up items (if any) | ||
|
|
||
| Your PR description should look something like [this](https://github.com/ace-step/ACE-Step-1.5/pull/309), demonstrating care and rigor applied by the author before hitting the PR button. If you have multiple Coderabbit/copilot responses to your PR, its probably a good idea to revoke the PR, fix the issues raised by the review bot, and resubmit. |
There was a problem hiding this comment.
Fix “its” and consider replacing “revoke the PR.”
“its” → “it’s”; “revoke” reads odd for PRs — “close” is clearer.
Suggested edit
-Your PR description should look something like [this](https://github.com/ace-step/ACE-Step-1.5/pull/309), demonstrating care and rigor applied by the author before hitting the PR button. If you have multiple Coderabbit/copilot responses to your PR, its probably a good idea to revoke the PR, fix the issues raised by the review bot, and resubmit.
+Your PR description should look something like [this](https://github.com/ace-step/ACE-Step-1.5/pull/309), demonstrating care and rigor applied by the author before hitting the PR button. If you have multiple Coderabbit/Copilot responses to your PR, it's probably a good idea to close the PR, fix the issues raised by the review bot, and resubmit.📝 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.
| Your PR description should look something like [this](https://github.com/ace-step/ACE-Step-1.5/pull/309), demonstrating care and rigor applied by the author before hitting the PR button. If you have multiple Coderabbit/copilot responses to your PR, its probably a good idea to revoke the PR, fix the issues raised by the review bot, and resubmit. | |
| Your PR description should look something like [this](https://github.com/ace-step/ACE-Step-1.5/pull/309), demonstrating care and rigor applied by the author before hitting the PR button. If you have multiple Coderabbit/Copilot responses to your PR, it's probably a good idea to close the PR, fix the issues raised by the review bot, and resubmit. |
🧰 Tools
🪛 LanguageTool
[style] ~161-~161: Consider using a different verb for a more formal wording.
Context: ... probably a good idea to revoke the PR, fix the issues raised by the review bot, an...
(FIX_RESOLVE)
🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` at line 161, Update the sentence in CONTRIBUTING.md that
reads “If you have multiple Coderabbit/copilot responses to your PR, its
probably a good idea to revoke the PR, fix the issues raised by the review bot,
and resubmit.” by correcting the typo “its” to the contraction “it’s” and
replacing the phrasing “revoke the PR” with a clearer option such as “close the
PR” (or “close it”), so the revised line reads along the lines of “If you have
multiple Coderabbit/copilot responses to your PR, it’s probably a good idea to
close the PR, fix the issues raised by the review bot, and resubmit.”
1 participant
Added a comprehensive guide for contributors outlining best practices, core principles, and a recommended AI coding workflow for making safe contributions to the project.
Summary by CodeRabbit