Skip to content

docs: update CONTRIBUTING.md to reflect pnpm/Biome migration #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Rawi2115 wants to merge 1 commit into
base: next
Choose a base branch
from
Open

docs: update CONTRIBUTING.md to reflect pnpm/Biome migration #839

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ If you're here though, you're probably one of the fewer ones.
## Things to keep in mind

The repository is holding the code for both Mantine DataTable package and its documentation website.
Since the repo root contains a `yarn.lock` file, it **should be obvious** that you have to use [Yarn](https://yarnpkg.com/) to install dependencies and run scripts.
Use `yarn dev` to start the development server, `yarn lint` to check the code for linting errors, and `yarn build` to check that the code compiles.
Running `yarn format` will automatically format your code with [Prettier](https://prettier.io/), so that it adheres to the project’s coding style.
Since the repo root contains a `pnpm-lock.yaml` file, it **should be obvious** that you have to use [pnpm](https://pnpm.io) to install dependencies and run scripts.
Use `pnpm dev` to start the development server, `pnpm lint` to check the code for linting errors, and `pnpm build` to check that the code compiles.
Running `pnpm format` will automatically format your code with [Biome](https://biomejs.dev/formatter/), so that it adheres to the project’s coding style.
This is a [Next.js](https://nextjs.org/) project with an [app router](https://nextjs.org/docs/app/building-your-application/routing) and makes use of [React Server Components]().
**Make sure you have a good grasp of the above before attempting to contribute.**

Expand Down