docs(contribution-guidelines): update installation steps #169
Conversation
|
Warning Rate limit exceeded@MFarabi619 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 5 seconds before requesting another review. ⌛ 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. 📝 Walkthrough📝 Walkthrough📝 Walkthrough📝 Walkthrough📝 WalkthroughWalkthroughThe pull request modifies the documentation for contribution guidelines, specifically enhancing the setup process for the project. Key changes include the addition of a warning about the Docker daemon, removal of legacy steps, and updates to the Google OAuth authentication instructions. The command for database migrations has been changed, and project commands have been updated to reflect a naming change from Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for docs-cuhacking ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
apps/docs/src/content/docs/contribution-guidelines/index.mdx (3)
180-182: Enhance the Docker daemon warning message.While the warning is well-placed, consider making it more specific for new users.
- Docker daemon (i.e. Docker Desktop) should be running before proceeding! + Docker daemon must be running (you should see the Docker Desktop icon in your system tray/menu bar) before proceeding!
211-213: Add environment variables format example.Consider adding an example format for the environment variables to prevent confusion.
Make a copy of the `.env.example` file in the `apps/portal` directory, and rename it to `.env.local`. Then, copy & paste the google client ID and secret into your the `.env.local` file as `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` respectively. + For example: + ```env + GOOGLE_CLIENT_ID=your-client-id-here.apps.googleusercontent.com + GOOGLE_CLIENT_SECRET=your-secret-here + ```
225-228: Add context for the database command change.Consider explaining the difference between
db:migrateanddb:pushto help users understand the change.Run Drizzle Push, to push the latest migration to your development database. + + > Note: We now use `db:push` instead of `db:migrate` as it automatically synchronizes your database schema with your Drizzle schema without requiring explicit migration files. ```sh title="Terminal" pnpm nx run db:push</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 2c5c18d9c42db8245b9d1750125fc09fecfb4655 and 86c02a6ff27febdf533bbd1e1c0d433389fc840d. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `apps/docs/src/content/docs/contribution-guidelines/index.mdx` (3 hunks) </details> <details> <summary>🔇 Additional comments (2)</summary> <details> <summary>apps/docs/src/content/docs/contribution-guidelines/index.mdx (2)</summary> `241-241`: **LGTM! Command updates are consistent.** The website command updates from `web` to `website` are correctly implemented across all usage scenarios. Also applies to: 246-246, 251-251 --- Line range hint `1-400`: **LGTM! Documentation structure is well-maintained.** The changes have been integrated seamlessly while maintaining the document's clear, step-by-step structure. The updates improve clarity and accuracy of the setup process. </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
✅ Deploy Preview for website-cuhacking ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JowiAoun
force-pushed
the
jowi/fix/project-setup
branch
2 times, most recently
from
b1cd63d
to
86c02a6
Compare
|
🎉 This issue has been resolved in version 1.5.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
.envvariables setup steps for authenticationdb:migratestep todb:pushwebas opposed towebsiteSummary by CodeRabbit