docs: improve README for better contributor onboarding#17
Conversation
|
@AyushSrivastava1818 is attempting to deploy a commit to the arpit2006's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
🎉 Thank you @AyushSrivastava1818 for submitting a Pull Request! We're excited to review your contribution. Before Review✅ Ensure all CI checks pass ⚡ Want faster reviews and contributor support? Join our Discord community: 🔗 Under Construction Maintainers and mentors are active there and can help resolve blockers quickly. Happy Contributing! 🚀 |
|
🎉 Thank you for your contribution to CampusCompass! We appreciate your effort in improving the project. Before review, please ensure:
A maintainer will review your contribution shortly. Happy contributing! 🚀 |
📝 WalkthroughWalkthroughREADME.md was rewritten with updated project positioning, simplified setup steps, an architecture overview, contribution guidance, a revised roadmap, FAQ entries, maintainer details, and support/licensing sections. ChangesREADME documentation refresh
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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: 2
🤖 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 `@README.md`:
- Around line 49-73: The Tech Stack section in README.md is outdated and doesn’t
match the actual runtime surfaced by app.js, config/db.js, and package.json.
Update the listed stack to reflect Express, EJS, express-session, Sequelize, and
the Postgres/SQLite drivers, or explicitly label React/Tailwind/MongoDB/JWT as
planned future work. Keep the README wording aligned with the current codebase
so readers don’t get conflicting signals.
- Around line 105-116: The project structure section in README.md does not match
the actual repository layout. Update the tree shown in the Project Structure
section to reflect the real top-level files and folders surfaced in the repo,
such as app.js, config/db.js, docs/architecture.md, public/, and the EJS views,
or clearly label the diagram as a future-state sketch. Use the existing “Project
Structure” heading and the surrounding README content as the place to correct
this so contributors are guided to the right locations.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ## 🛠️ Tech Stack | ||
|
|
||
| - **Frontend**: HTML5, CSS3 (Vanilla CSS), JavaScript (ES6) | ||
| - **Backend**: Node.js, Express.js | ||
| - **Database**: Local JSON File Database (completely free and zero-configuration) | ||
| - **Template Engine**: EJS (Embedded JavaScript) | ||
| - **Authentication**: Cookie-based sessions with `express-session` & `bcryptjs` | ||
| ### Frontend | ||
|
|
||
| * React.js | ||
| * Tailwind CSS | ||
|
|
||
| ### Backend | ||
|
|
||
| * Node.js | ||
| * Express.js | ||
|
|
||
| ### Database | ||
|
|
||
| * MongoDB | ||
|
|
||
| ### Authentication | ||
|
|
||
| * JWT Authentication | ||
|
|
||
| ### Other Tools | ||
|
|
||
| * Git & GitHub | ||
| * REST APIs | ||
|
|
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Align the tech stack with the codebase.
React.js/Tailwind CSS/MongoDB/JWT Authentication conflict with the surfaced runtime: app.js uses express-session + EJS, config/db.js uses Sequelize with Postgres/SQLite, and package.json lists Express/EJS/pg drivers instead. Please update this section to the actual stack or clearly mark these items as planned work.
🤖 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 49 - 73, The Tech Stack section in README.md is
outdated and doesn’t match the actual runtime surfaced by app.js, config/db.js,
and package.json. Update the listed stack to reflect Express, EJS,
express-session, Sequelize, and the Postgres/SQLite drivers, or explicitly label
React/Tailwind/MongoDB/JWT as planned future work. Keep the README wording
aligned with the current codebase so readers don’t get conflicting signals.
| ## 📁 Project Structure | ||
|
|
||
| ```text | ||
| CampusCompass | ||
| │ | ||
| ├── client/ | ||
| ├── server/ | ||
| ├── public/ | ||
| ├── src/ | ||
| ├── docs/ | ||
| └── README.md | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Make the project tree reflect the real repository layout.
This tree points contributors at client/, server/, and src/, but the surfaced files are app.js, config/db.js, docs/architecture.md, public/, and EJS views. As written, new contributors will search in the wrong places. Either mirror the current layout or clearly mark this as a future-state sketch.
🤖 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 105 - 116, The project structure section in README.md
does not match the actual repository layout. Update the tree shown in the
Project Structure section to reflect the real top-level files and folders
surfaced in the repo, such as app.js, config/db.js, docs/architecture.md,
public/, and the EJS views, or clearly label the diagram as a future-state
sketch. Use the existing “Project Structure” heading and the surrounding README
content as the place to correct this so contributors are guided to the right
locations.
|
🎉 Congratulations! Thank you for your contribution to CampusCompass. ✅ Your pull request has been successfully merged. We appreciate your effort and look forward to more contributions from you. Happy coding! 🚀 |
2 participants
What does this PR do?
This PR enhances the README to improve project discoverability and contributor onboarding by adding:
Why were screenshots and demo links not added?
I intentionally left out screenshots and demo/deployment links in this PR because:
Closes #9
Summary by CodeRabbit