Skip to content

docs: update CONTRIBUTING i18n and lint docs#2336

Merged
MatteoGabriele merged 8 commits intonpmx-dev:mainfrom
alfonsusac:contributor-docs-update
Mar 31, 2026
Merged

docs: update CONTRIBUTING i18n and lint docs#2336
MatteoGabriele merged 8 commits intonpmx-dev:mainfrom
alfonsusac:contributor-docs-update

Conversation

@alfonsusac
Copy link
Copy Markdown
Contributor

🔗 Linked issue

📚 Description

Removes deprecated/unused script entries in accordance to commands specified in package.json. Hopefully this helps reduce friction for future contributors.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs.npmx.dev Ready Ready Preview, Comment Mar 31, 2026 5:00pm
npmx.dev Ready Ready Preview, Comment Mar 31, 2026 5:00pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
npmx-lunaria Ignored Ignored Mar 31, 2026 5:00pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 90f95dc5-bae3-43ed-ad02-f277a3871f77

📥 Commits

Reviewing files that changed from the base of the PR and between 50615c9 and 96d57c5.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

This PR updates CONTRIBUTING.md. The Code Quality lint command is changed from pnpm lint to pnpm vp run lint; pnpm lint:fix and pnpm test:types are unchanged. The i18n commands table is reworked: rows for pnpm i18n:check, pnpm i18n:check:fix, pnpm i18n:report, pnpm i18n:report:fix, and pnpm i18n:schema were removed and replaced with entries using pnpm i18n:check:fix, pnpm i18n:report:fix, and pnpm vp run i18n:check, pnpm vp run i18n:report, pnpm vp run i18n:schema. The "Update translation" step now uses pnpm i18n:check:fix. The translation key conventions note references pnpm i18n:report:fix. No code or exported API changes.

Possibly related PRs

Suggested reviewers

  • danielroe
🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description clearly relates to the changeset, explaining that deprecated/unused script entries are being removed from CONTRIBUTING.md to match package.json commands.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@alfonsusac alfonsusac changed the title docs: Update CONTRIBUTING i18n and lint docs docs: update CONTRIBUTING i18n and lint docs Mar 30, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 | 🟠 Major

CI workflow still uses pnpm lint but it's no longer documented.

The CI workflow (.github/workflows/ci.yml:42) runs pnpm 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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 970068fb-7a64-4acf-b03b-971d8de2c577

📥 Commits

Reviewing files that changed from the base of the PR and between 516808b and 48213d8.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Co-authored-by: Felix Schneider <99918022+trueberryless@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@trueberryless trueberryless left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing 🤩

Thank you @alfonsusac for this important contribution! 🙌
All the changes look good to me, approved ✅

Copy link
Copy Markdown
Member

@MatteoGabriele MatteoGabriele left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome! Thanks a lot for this update ✨

@MatteoGabriele MatteoGabriele added this pull request to the merge queue Mar 31, 2026
Merged via the queue into npmx-dev:main with commit 2e0fb05 Mar 31, 2026
20 checks passed
@github-actions github-actions bot mentioned this pull request Mar 31, 2026
@alfonsusac alfonsusac deleted the contributor-docs-update branch March 31, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants