Skip to content

Commit 509ef1f

Browse files
committed
chore: Update Contributing doc with pnpm info
1 parent 8998282 commit 509ef1f

File tree

3 files changed

+174
-245
lines changed

3 files changed

+174
-245
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,77 @@
11
# Contributing
22

3-
Hi! We're looking for some help, and we're excited that you're interested!
4-
We want contributing to this project to be enjoyable and productive for everyone.
5-
All contributions are welcome, including opening and commenting on issues and pull requests, adding or updating the docs,
6-
bug fixes, blog posts, and suggestions for new features.
7-
We follow a [Code of Conduct](CODE_OF_CONDUCT.md), so please be kind to others and reach out if you have any questions or concerns.
3+
Hi! We're looking for some help, and we're excited that you're interested! We
4+
want contributing to this project to be enjoyable and productive for everyone.
5+
All contributions are welcome, including opening and commenting on issues and
6+
pull requests, adding or updating the docs, bug fixes, blog posts, and
7+
suggestions for new features. We follow a [Code of Conduct](CODE_OF_CONDUCT.md),
8+
so please be kind to others and reach out if you have any questions or concerns.
89

9-
Theme UI is still in an early stage and things will likely move quickly.
10-
The time to review a pull request depends on the complexity involved,
11-
so please be patient if a particular feature takes longer to review than others.
10+
Theme UI is still in an early stage and things will likely move quickly. The
11+
time to review a pull request depends on the complexity involved, so please be
12+
patient if a particular feature takes longer to review than others.
1213

1314
## Local Development
1415

15-
This repo uses [Yarn Workspaces][] and [Lerna][] to develop multiple packages together as a monorepo.
16-
Be sure to install [Yarn][] before setting up the development environment.
16+
This repo uses [pnpm workspaces][] to develop multiple packages together as a
17+
monorepo. Be sure to [install pnpm][] before setting up the development
18+
environment.
1719

1820
Install dependencies and link local packages in the root directory:
1921

2022
```sh
21-
yarn
23+
pnpm i
2224
```
2325

24-
In `postinstall` script running after dependencies install, [Preconstruct][] links source files to dist directories.
26+
In `postinstall` script running after dependencies install, [Preconstruct][]
27+
links source files to dist directories.
2528

26-
Depending on the part of the codebase you're working on, you'll want to run tests or docs development server.
29+
Depending on the part of the codebase you're working on, you'll want to run
30+
tests or docs development server.
2731

2832
## Working on the docs
2933

30-
The docs are using Gatsby. To start development server run
34+
The docs are using Gatsby. To start development server run:
3135

3236
```sh
33-
yarn workspace docs start
37+
pnpm run dev:docs
3438
```
3539

3640
Changes to libraries will immediately hot reload the docs.
3741

3842
## Tests
3943

40-
Unit tests are run with [Jest][], and each package should include a `test/` directory with unit tests for that package.
44+
Unit tests are run with [Jest][], and each package should include a `test/`
45+
directory with unit tests for that package.
4146

4247
Running tests:
4348

4449
```sh
45-
yarn test
50+
pnpm test
4651
```
4752

4853
Running tests in watch mode:
4954

5055
```sh
51-
yarn test --watch
56+
pnpm test --watch
5257
```
5358

54-
You can specify what tests to run by passing test path pattern as the first positional argument and test name pattern after `-t` flag.
59+
You can specify what tests to run by passing test path pattern as the first
60+
positional argument and test name pattern after `-t` flag.
5561

5662
```sh
57-
yarn test core/test/react-jsx -t 'accepts sx prop'
63+
pnpm test core/test/react-jsx -t 'accepts sx prop'
5864
```
5965

6066
## Pull Requests
6167

62-
When opening a pull request, please be sure to update any relevant documentation in the READMEs or in the `packages/docs` directory.
63-
Also include a high-level list of changes in the [CHANGELOG.md](CHANGELOG.md) file at the top under the `## Unreleased` heading.
68+
When opening a pull request, please be sure to update any relevant documentation
69+
in the READMEs or in the `packages/docs` directory. Also include a high-level
70+
list of changes in the [CHANGELOG.md](CHANGELOG.md) file at the top under the
71+
`## Unreleased` heading.
6472

65-
[yarn]: https://yarnpkg.com
66-
[yarn workspaces]: https://yarnpkg.com/en/docs/workspaces
67-
[lerna]: https://github.com/lerna/lerna
73+
[pnpm workspaces]: https://pnpm.io/workspaces
74+
[install pnpm]: https://pnpm.io/installation
6875
[jest]: https://jestjs.io/
69-
[preconstruct]: https://preconstruct.tools/guides/using-preconstruct-dev-in-a-monorepo
76+
[preconstruct]:
77+
https://preconstruct.tools/guides/using-preconstruct-dev-in-a-monorepo

packages/theme-ui/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ scales help you build UI rooted in constraint-based design principles.
116116
npm install theme-ui @emotion/react
117117
```
118118

119-
_If you don't need color modes, components and MDX support, you can install
119+
_If you don't need color modes, components, or MDX support, you can install
120120
[**@theme-ui/core**](https://github.com/system-ui/theme-ui/tree/develop/packages/core)_.
121121

122122
Any styles in your app can reference values from the global `theme` object. To

0 commit comments

Comments
 (0)