Repository navigation
Conversation
|
@kavix is attempting to deploy a commit to the ClaraClency Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThis PR adds standardized contribution templates and rewrites the contribution guide. Three new GitHub issue/PR templates define structured forms for bug reports, feature requests, and pull requests. The CONTRIBUTING.md guide is rewritten with explicit prerequisites, local development setup steps for backend and frontend, testing guidance, code style and commit conventions, and PR workflow. README.md is simplified to reference the new CONTRIBUTING.md. ChangesContribution Process Standardization
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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
🤖 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 @.github/ISSUE_TEMPLATE/bug_report.md:
- Around line 26-29: Replace the incorrect "iOS" example in the "Desktop (please
complete the following information):" section with appropriate desktop OS
examples; update the Browser/Version lines if desired to keep examples coherent
(suggested replacements: "macOS", "Windows 10", or "Ubuntu 22.04") so the
Desktop example reflects actual desktop operating systems.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e6038e2a-a8e3-4cb2-bd59-ba1c708e3c55
📒 Files selected for processing (5)
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.md.github/pull_request_template.mdCONTRIBUTING.mdREADME.md
✅ Deploy Preview for livedit canceled.
|
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
315-320: ⚡ Quick winKeep the contribution instructions single-sourced.
These steps duplicate what
CONTRIBUTING.mdalready covers, and theTESTING.mdlink is now easy to let drift. Either trim this section down to the new pointer or update it to referenceCONTRIBUTING.mdonly. Please verify whetherTESTING.mdis still intended to be maintained.♻️ Proposed fix
## 🤝 Contributing We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started, our code of conduct, and the process for submitting pull requests. -1. Create a feature branch -2. Make your changes -3. Test locally (both frontend & backend) -4. Submit PR with description -5. See [TESTING.md](./TESTING.md) for the full testing guide.🤖 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 `@README.md` around lines 315 - 320, The contribution instructions in README.md (the numbered steps 1-5 under the contribution section) are duplicating content that already exists in CONTRIBUTING.md, creating a single-sourcing problem where these instructions could drift apart. Remove the detailed numbered steps from the README.md contribution section and instead keep only a brief reference directing contributors to CONTRIBUTING.md as the authoritative source for contribution guidelines. Additionally, verify that TESTING.md is still actively maintained and up-to-date, since it is referenced in the proposed changes.
🤖 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.
Nitpick comments:
In `@README.md`:
- Around line 315-320: The contribution instructions in README.md (the numbered
steps 1-5 under the contribution section) are duplicating content that already
exists in CONTRIBUTING.md, creating a single-sourcing problem where these
instructions could drift apart. Remove the detailed numbered steps from the
README.md contribution section and instead keep only a brief reference directing
contributors to CONTRIBUTING.md as the authoritative source for contribution
guidelines. Additionally, verify that TESTING.md is still actively maintained
and up-to-date, since it is referenced in the proposed changes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1d90d1f8-f575-4b80-96d1-da6fb802df4c
📒 Files selected for processing (2)
.github/ISSUE_TEMPLATE/bug_report.mdREADME.md
✅ Files skipped from review due to trivial changes (1)
- .github/ISSUE_TEMPLATE/bug_report.md
|
Hi @clencyc , this PR is ready for review whenever you have a free moment. Thanks! |
Add Contributing Guidelines and GitHub Templates
#13
Fixes #42
Summary
This PR introduces comprehensive contributor documentation and standardized GitHub templates to streamline onboarding, improve contribution quality, and establish consistent development workflows across the project.
Changes Made
1. Added
CONTRIBUTING.mdCreated a detailed contribution guide covering:
Development Environment Setup
Testing Guidelines
Code Style Standards
Git Workflow
feat,fix,docs, etc.)Pull Request Process
Issue Reporting
2. Added GitHub Templates
Introduced standardized templates to improve issue and PR quality:
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.md.github/pull_request_template.md3. Updated
README.mdCONTRIBUTING.mdguide in the Contributing section.Motivation
These additions lower the barrier to entry for new contributors, provide clear development standards, and help maintain code quality through a consistent contribution process. Standardized templates also reduce review friction by ensuring that issues and pull requests contain the necessary information from the start.
Checklist
CONTRIBUTING.mdwith setup, style, and contribution guidelinesREADME.mdto link to the contribution guideSummary by CodeRabbit
Summary by CodeRabbit