docs: expand contribution guide - #4466
Open
vittorioexp wants to merge 1 commit into
Open
Conversation
Add contribution types table and PR checklist for fixes, features, presets, and docs. Closes nitrojs#2213.
|
@vittorioexp is attempting to deploy a commit to the Nitro Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
📝 WalkthroughWalkthrough
ChangesContribution guide
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 31-32: Update the pull request checklist in CONTRIBUTING.md to
strengthen bug-fix guidance by requiring a minimal reproduction or relevant
context, and add the security-fix requirement directing contributors to report
through SECURITY.md before opening a PR. Preserve the existing
conventional-commit and related-issue checklist items.
🪄 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
+31
to
+32
| - Use [conventional commits](https://www.conventionalcommits.org/) in the PR title (for example `fix(preset): …`, `docs: …`, `feat: …`). | ||
| - Link the related issue when one exists. |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Align the checklist with the repository PR template.
The checklist omits the existing security-fix requirement and weakens the bug-fix guidance. Please mention that bug-fix issues should include a minimal reproduction/context, and that security fixes must be reported through SECURITY.md before opening a PR.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CONTRIBUTING.md` around lines 31 - 32, Update the pull request checklist in
CONTRIBUTING.md to strengthen bug-fix guidance by requiring a minimal
reproduction or relevant context, and add the security-fix requirement directing
contributors to report through SECURITY.md before opening a PR. Preserve the
existing conventional-commit and related-issue checklist items.
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.
Summary
Closes #2213.
Expands CONTRIBUTING.md with contribution types (docs, bug fixes, features, presets, examples) and a pull request checklist.
Test plan