Skip to content

docs: update CONTRIBUTING.md to match actual tooling - #991

Merged
B4nan merged 1 commit into
masterfrom
docs/contributing-oxlint-oxfmt
Aug 3, 2026
Merged

docs: update CONTRIBUTING.md to match actual tooling#991
B4nan merged 1 commit into
masterfrom
docs/contributing-oxlint-oxfmt

Conversation

@B4nan

@B4nan B4nan commented Aug 3, 2026

Copy link
Copy Markdown
Member

CONTRIBUTING.md still described the setup from before the oxc migration, so this brings it in line with the actual scripts in package.json:

  • npm commands are now pnpm (the repo uses packageManager: pnpm@10.33.4), including the npm 10+ prerequisite
  • the lint and format scripts are described as oxlint (--type-aware) and oxfmt instead of ESLint and Prettier
  • the Code Style section points to .oxfmtrc.json and oxlint.config.ts instead of the removed .prettierrc and eslint.config.mjs
  • the npx vitest examples now use pnpm vitest

This only touches CONTRIBUTING.md.

The repo migrated to pnpm, oxlint, and oxfmt, but CONTRIBUTING.md
still described the setup as npm, ESLint, and Prettier, and pointed
to config files that no longer exist.
@B4nan B4nan added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Aug 3, 2026
@github-actions github-actions Bot added this to the 146th sprint - Tooling team milestone Aug 3, 2026
@B4nan
B4nan requested a review from vdusek August 3, 2026 16:28

@vdusek vdusek left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@B4nan
B4nan merged commit bed435c into master Aug 3, 2026
7 checks passed
@B4nan
B4nan deleted the docs/contributing-oxlint-oxfmt branch August 3, 2026 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants