feat: Update CONTRIBUTING.md to help first-time contributors.#567
feat: Update CONTRIBUTING.md to help first-time contributors.#567alexoneill wants to merge 4 commits intojniebuhr:masterfrom
Conversation
Adds updated information about the CLA and commands to deploy firmware.
|
We require contributors to sign our Contributor License Agreement, and we don't have yours on file. In order for us to review and merge your code, please contact @jniebuhr (mdwasp) on Discord to get yourself added. |
|
Warning Rate limit exceeded
⌛ 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. 📝 WalkthroughWalkthroughUpdates to CONTRIBUTING.md add a Contributor License Agreement requirement, expand and reformat Getting Started and deployment instructions (including a combined deployment table and example sequence), tighten script path formatting, add Prettier markdown tips, and add PR guidance and an issue reporting section. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
44-45:⚠️ Potential issue | 🟡 MinorFix the likely typo in the library path.
lib/GaggiMateControllelooks misspelled and will confuse new contributors—should it belib/GaggiMateController?✅ Suggested fix
-Located in `lib/GaggiMateControlle` and `src/controller`. +Located in `lib/GaggiMateController` and `src/controller`.
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 60-62: Update the three command description lines (`npm run dev`,
`npm run build`, `npm run preview`) to avoid bare URLs by wrapping them in angle
brackets or using markdown link syntax; for example, change
"http://localhost:5173/" and "http://localhost:4173/" to
`<http://localhost:5173/>` and `<http://localhost:4173/>` or
`http://localhost:5173/` as `[http://localhost:5173/](http://localhost:5173/)`
so markdownlint no longer flags bare URLs in those command entries.
|
We require contributors to sign our Contributor License Agreement, and we don't have yours on file. In order for us to review and merge your code, please contact @jniebuhr (mdwasp) on Discord to get yourself added. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 7-9: Replace the wordy phrase "In order for us to review and merge
your code," in the CONTRIBUTING.md sentence with the tighter "To review and
merge your code," so the line reads: "To review and merge your code, please
contact `@jniebuhr` (mdwasp) on Discord to access the CLA." Ensure the rest of the
sentence and CLA reference remain unchanged.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
90-95: Consider avoiding HTML<pre>inside the table for portability.Some markdown renderers (including GitHub-flavored variants in other tooling) can be inconsistent with
<pre>inside tables. A plain code block under the table or a compact multi-line command using<br>inside a normal table cell (without<pre>) tends to render more reliably.
|
We require contributors to sign our Contributor License Agreement, and we don't have yours on file. In order for us to review and merge your code, please contact @jniebuhr (mdwasp) on Discord to get yourself added. |
|
We require contributors to sign our Contributor License Agreement, and we don't have yours on file. In order for us to review and merge your code, please contact @jniebuhr (mdwasp) on Discord to get yourself added. |
|
1 participant
Adds updated information about the CLA and commands to deploy firmware.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.