You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Hello! Thanks for contributing to Zedux. Read this message and delete it to ackn
4
4
5
5
Make sure you've followed the [contribution guidelines](https://github.com/Omnistac/zedux/blob/master/CONTRIBUTING.md). Specifically:
6
6
7
-
- Make sure the first commit is formatted correctly (via running `yarn commit` in the repo root) and indicates all affected packages.
7
+
- Make sure the first commit is formatted correctly (via running `pnpm commit` in the repo root) and indicates all affected packages.
8
8
9
9
We'll use this to generate the changelog and release notes if your PR is merged. Any other commits will be squashed into the first commit. Each PR can only have one commit, so separate changes into separate PRs if needed.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,20 @@ Abide by the [code of conduct](CODE_OF_CONDUCT.md).
2
2
3
3
## Starting Development
4
4
5
-
We use `yarn` to manage package dependencies. Simply running `yarn` in the repo root is all you need to get started with developing the packages.
5
+
We use `pnpm` to manage package dependencies. Simply running `pnpm i` in the repo root is all you need to get started with developing the packages.
6
6
7
-
We use Nx with yarn workspaces to manage the package-based monorepo. Every directory in the `packages/` folder is its own npm package. Run `yarn nx graph` to see the dependency graph of Zedux packages.
7
+
We use Nx with pnpm workspaces to manage the package-based monorepo. Every directory in the `packages/` folder is its own npm package. Run `pnpm nx graph` to see the dependency graph of Zedux packages.
8
8
9
-
We recommend Test-Driven Development for most Zedux code changes. Add integration tests and run `yarn test my-test-file` in the repo root to check changes.
9
+
We recommend Test-Driven Development for most Zedux code changes. Add integration tests and run `pnpm run test my-test-file` in the repo root to check changes.
10
10
11
11
### Docs
12
12
13
-
The docs are separated from the rest of the repo - they're not a yarn workspace. To run the docs site:
13
+
The docs are separated from the rest of the repo - they're not a pnpm workspace. To run the docs site:
14
14
15
15
```sh
16
16
cd docs
17
-
yarn
18
-
yarn start
17
+
pnpm i
18
+
pnpm start
19
19
```
20
20
21
21
This sets up an HMR-enabled dev server for quickly previewing docs site changes.
@@ -28,7 +28,7 @@ Properly type everything - no `any`s unless it's the correct type or you demonst
28
28
29
29
Add integration tests in the `test/integrations` folder of the appropriate package(s) to **fully** demonstrate all desired functionality. Unit tests aren't required if all functionality is covered well in integration tests, but they are a nice-to-have.
30
30
31
-
Ensure that all tests pass by running `yarn test` in the repo root. That command will also output code coverage. Ensure that all changes have full Statement, Branch, Function, and Line coverage.
31
+
Ensure that all tests pass by running `pnpm test` in the repo root. That command will also output code coverage. Ensure that all changes have full Statement, Branch, Function, and Line coverage.
32
32
33
33
The PR title should be in the same format as the main commit. E.g. `feat(react): implement cool new thing`
34
34
@@ -40,15 +40,15 @@ Make the PR directly against Zedux `master` branch unless it's a hotfix for a sp
40
40
41
41
If your PR can't be merged due to conflicts, rebase against Zedux master, resolve conflicts locally, and force push the changes.
42
42
43
-
If your PR requires changes, you can push those as separate commits (only the first commit has to follow the [commit message guidelines](#commit-messages) via `yarn commit`. All other commits can be free-form via `git commit`). Or you can `git commit --amend` a previous commit and force push.
43
+
If your PR requires changes, you can push those as separate commits (only the first commit has to follow the [commit message guidelines](#commit-messages) via `pnpm commit`. All other commits can be free-form via `git commit`). Or you can `git commit --amend` a previous commit and force push.
44
44
45
45
## Commit Messages
46
46
47
47
We use a custom script to generate the CHANGELOG from commit messages. Thus commit messages must follow a specific format. This format is a simplification of the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
48
48
49
-
Use `yarn commit` (in the repo root) instead of `git commit` to make our custom commit formatter tool automatically format these correctly for you.
49
+
Use `pnpm commit` (in the repo root) instead of `git commit` to make our custom commit formatter tool automatically format these correctly for you.
50
50
51
-
It's recommended to always use `yarn commit`, but if you want to know the format that it outputs, here it is:
51
+
It's recommended to always use `pnpm commit`, but if you want to know the format that it outputs, here it is:
0 commit comments