Skip to content

Commit

Permalink
docs(CONTRIBUTING.md): add period
Browse files Browse the repository at this point in the history
  • Loading branch information
sukvvon committed Feb 1, 2025
1 parent 547437e commit cb1b410
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,36 +46,36 @@ If you would like to contribute by fixing an open issue or developing a new feat

#### General

1. Fork this repository
2. Create a new feature branch based off the `main` branch
3. Follow the [Core](#Core) and/or the [Documentation](#Documentation) guide below and come back to this once done
4. Run `pnpm run fix:format` to format the code
5. Git stage your required changes and commit (review the commit guidelines below)
6. Submit the PR for review
1. Fork this repository.
2. Create a new feature branch based off the `main` branch.
3. Follow the [Core](#Core) and/or the [Documentation](#Documentation) guide below and come back to this once done.
4. Run `pnpm run fix:format` to format the code.
5. Git stage your required changes and commit (review the commit guidelines below).
6. Submit the PR for review.

##### Core

1. Install dependencies by running `pnpm install`.
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)_
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)_
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
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.

### Pull Requests

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or request improvements, therefore, please check ✅ ["Allow edits from maintainers"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on your PR
After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or request improvements, therefore, please check ✅ ["Allow edits from maintainers"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) on your PR.

## Zustand-specific Guideline

##### Documentation

Our [docs](https://zustand.docs.pmnd.rs) are based on [`pmndrs/docs`](https://github.com/pmndrs/docs).

1. Separately, clone the `pmndrs/docs`. (you don't need to fork it)
1. Separately, clone the `pmndrs/docs`. (you don't need to fork it).
2. Inside the `pmndrs/docs` directory:
1. Create a `.env` file in the root directory with the next environment variables: `MDX=docs/zustand/docs` and `HOME_REDIRECT=/getting-started/introduction`.
2. Install dependencies by running `npm install`, then `npm run dev` to start the dev server.
Expand Down

0 comments on commit cb1b410

Please sign in to comment.