diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f30f2762..02f6957e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,12 +2,16 @@ After forking the repository, run the following commands to get started: -0. Ensure you have [Node.js](https://nodejs.org) installed. Enable corepack with `corepack enable`. +0. Ensure you have [Node.js](https://nodejs.org) installed. Enable corepack with `corepack enable` *(1). 1. Install dependencies: `pnpm i` -2. Start the project in development mode: `pnpm start` +2. Start the project in development mode: `pnpm start` or build the project for production: `pnpm build` 3. Read the [Tasks Categories](#tasks-categories) and [Workflow](#workflow) sections below 4. Let us know if you are working on something and be sure to open a PR if you got any changes. Happy coding! +*(1): If you are getting `Cannot find matching keyid` update corepack to the latest version with `npm i -g corepack`. +*(2): If still something doesn't work ensure you have the right nodejs version with `node -v` (tested on 22.x) +*(3): For GitHub codespaces (cloud ide): Run `pnpm i @rsbuild/core@1.2.4 @rsbuild/plugin-node-polyfill@1.3.0 @rsbuild/plugin-react@1.1.0 @rsbuild/plugin-typed-css-modules@1.0.2` command to avoid crashes because of limited ram + ## Project Structure There are 3 main parts of the project: