docs: update CONTRIBUTING i18n and lint docs#2336
docs: update CONTRIBUTING i18n and lint docs#2336MatteoGabriele merged 8 commits intonpmx-dev:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR updates CONTRIBUTING.md. The Code Quality lint command is changed from Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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)
122-123:⚠️ Potential issue | 🟠 MajorCI workflow still uses
pnpm lintbut it's no longer documented.The CI workflow (
.github/workflows/ci.yml:42) runspnpm vp run lint, but this command has been removed from CONTRIBUTING.md. Contributors who encounter CI lint failures will not be able to reproduce them locally without this guidance.Consider restoring the command entry:
# Code Quality +pnpm lint # Run lint checks (used by CI) pnpm lint:fix # Auto-fix lint issues pnpm test:types # TypeScript type checking
Co-authored-by: Felix Schneider <99918022+trueberryless@users.noreply.github.com>
trueberryless
left a comment
There was a problem hiding this comment.
Amazing 🤩
Thank you @alfonsusac for this important contribution! 🙌
All the changes look good to me, approved ✅
MatteoGabriele
left a comment
There was a problem hiding this comment.
awesome! Thanks a lot for this update ✨
🔗 Linked issue
📚 Description
Removes deprecated/unused script entries in accordance to commands specified in package.json. Hopefully this helps reduce friction for future contributors.