📘 docs: add CONTRIBUTING.md with setup guide and troubleshooting#248
📘 docs: add CONTRIBUTING.md with setup guide and troubleshooting#248Satyanarayana001 wants to merge 7 commits intoAOSSIE-Org:mainfrom
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 10 minutes and 15 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 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 |
|
Hi 👋, this PR focuses only on adding the CONTRIBUTING.md with setup instructions and a troubleshooting guide. Please let me know if any improvements are needed. Thanks! |
|
Hi 👋, I noticed there is another PR addressing a similar contribution. I created this based on the suggestion shared on Discord to improve contributor onboarding. Please let me know which approach is preferred or if I can refine this further. Happy to collaborate or update accordingly. |
|
Hi 👋, just a gentle follow-up on this PR. This adds a structured CONTRIBUTING.md with setup instructions and troubleshooting to improve onboarding for new contributors. Please let me know if any changes are needed. Thanks! |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 29-31: The fenced code block containing "> ⚠️ If `.env.example` is
missing, create `.env` manually using the variables below." in CONTRIBUTING.md
violates MD031 (no blank lines around fenced blocks); update the surrounding
markdown so there is a blank line before and after this fenced block (and
likewise fix the other listed fences at the referenced regions 110-114, 116-120,
141-143) to normalize blank lines around all fenced blocks and satisfy the
repository's **/*.md formatting rules.
- Line 90: Two fenced code blocks are missing language identifiers (MD040);
update the backtick fences that wrap the snippet starting with "Ell-ena/" and
the commit message list starting with "feat: add dark mode toggle" to include a
language tag (e.g., ```text) so linters and renderers treat them correctly;
replace the opening ``` with ```text for both blocks and leave the closing ```
unchanged.
- Line 17: Replace the broken TOC fragment link in CONTRIBUTING.md by updating
the link text "- [Common Issues](`#-common-issues--fixes`)" to use a stable
explicit anchor without the leading hyphen (e.g., change
"#-common-issues--fixes" to "#common-issues--fixes" or to the exact slug
generated by the "Common Issues — Fixes" heading), ensuring the fragment matches
the actual heading slug so markdownlint MD051 is resolved.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: bddeef71-73e6-4aac-ac7c-bcbfe57b8550
📒 Files selected for processing (1)
CONTRIBUTING.md
|
Hi 👋, All suggested changes have been addressed, including formatting improvements and markdown fixes. Please let me know if anything else is needed. Thanks! |
Satyanarayana001
left a comment
There was a problem hiding this comment.
Hi 👋,
All suggested changes have been addressed, including formatting improvements, spacing fixes, and proper language identifiers for code blocks.
Please let me know if anything else is needed. Thanks!
Satyanarayana001
left a comment
There was a problem hiding this comment.
Hi 👋,
All suggested changes have been addressed, including formatting improvements, spacing fixes, and proper language identifiers for code blocks.
Please let me know if anything else is needed. Thanks!
|
Hi 👋, All review comments from CodeRabbit have been addressed, including:
The PR is now updated and ready for review. Please let me know if anything else is required. Thanks! 🙌 |
📘 Add CONTRIBUTING.md
🧩 Problem
Many contributors face difficulties while setting up Ell-ena locally, especially with environment configuration and running the app successfully.
✅ Solution
Added a comprehensive
CONTRIBUTING.mdthat includes:.envflutter analyze)🚀 Impact
💡 Notes
This PR only adds documentation and does not modify any existing functionality.
✨ Happy Contributing!
Summary by CodeRabbit