Skip to content

Commit

Permalink
docs(CONTRIBUTING.md): unify the tone of the command part
Browse files Browse the repository at this point in the history
  • Loading branch information
sukvvon committed Feb 1, 2025
1 parent c28ab2e commit a867344
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ If you would like to contribute by fixing an open issue or developing a new feat

##### Core

1. Install dependencies by running `pnpm install`.
1. Run `pnpm install` to install dependencies.
2. Create failing tests for your fix or new feature in the [`tests`](./tests/) folder.
3. Implement your changes.
4. Build the library by running `pnpm run build`. _(Pro-tip: `pnpm run build-watch` runs the build in watch mode)_
4. Run `pnpm run build` to build the library. _(Pro-tip: `pnpm run build-watch` runs the build in watch mode)_
5. Run the tests by running `pnpm run test` and ensure that they pass.
6. You can use `pnpm link` to sym-link this package and test it locally on your own project. Alternatively, you may use CodeSandbox CI's canary releases to test the changes in your own project. (requires a PR to be created first)
7. Follow step 4 and onwards from the [General](#General) guide above to bring it to the finish line.
Expand All @@ -74,7 +74,7 @@ After you have submitted your pull request, we'll try to get back to you as soon
##### Documentation

1. Navigate to the [`website`](./website/) folder. (e.g., `cd website`).
2. Install dependencies by running `pnpm install` in the `website` folder.
2. Run `pnpm install` to install dependencies in the `website` folder.
3. Run `pnpm run dev` to start the dev server.
4. Navigate to [`http://localhost:3000`](http://localhost:3000) to view the documents.
5. Navigate to the [`docs`](./docs/) folder and make necessary changes to the documents.
Expand Down

0 comments on commit a867344

Please sign in to comment.