Skip to content

Commit 136382d

Browse files
committed
docs: add build step to yarn link documentation
1 parent 3964ede commit 136382d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/contributing.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,15 @@ We welcome contributions in the form of comments, issues, or pull requests with
2727
## Environment setup
2828

2929
1. Use the node environment manager of your choice, but make sure you have the required version specified by the project.
30-
- The version required by the project can be found in [`.node-version`](../.node-version).
30+
- The version required by the project can be found in [`.node-version`](../.node-version).
3131
- We recommend using a single tool version manager such as [mise-en-place](https://mise.jdx.dev/), [asdf](https://asdf-vm.com/), or (specific to just Node) [nodenv](https://github.com/nodenv/nodenv) to manage your node version on this project.
3232
If you already have a preferred node version manager installed, use it.
33-
34-
> [!NOTE]
35-
> If using asdf, you must [enable `legacy_version_file`](https://asdf-vm.com/manage/configuration.html#legacy-version-file) to have the tool version picked up from `.node-version`
36-
> Mise supports `.node-version` [as a default](https://mise.jdx.dev/configuration.html#idiomatic-version-files). If you're having trouble, make sure that setting is not set to false.
3733

38-
2. Use [yarn](https://yarnpkg.com) to manage JS packages.
34+
> [!NOTE]
35+
> If using asdf, you must [enable `legacy_version_file`](https://asdf-vm.com/manage/configuration.html#legacy-version-file) to have the tool version picked up from `.node-version`
36+
> Mise supports `.node-version` [as a default](https://mise.jdx.dev/configuration.html#idiomatic-version-files). If you're having trouble, make sure that setting is not set to false.
3937
38+
2. Use [yarn](https://yarnpkg.com) to manage JS packages.
4039
- [Install yarn](https://yarnpkg.com/en/docs/install) if you do not already have it.
4140
- Type `yarn` or `yarn install` inside the project directory to install dependencies. You will need to do this once after cloning the project, and continuously if the dependencies in `package.json` change.
4241

@@ -56,6 +55,7 @@ These should all be run from within the project directory.
5655
- `yarn build`
5756
- Builds files from `/src` and outputs to `/lib` using webpack and UMD library target
5857
- `yarn build:watch` is also available
58+
5959
## Development
6060

6161
### Working on an issue
@@ -87,7 +87,7 @@ More guidance for preferred React practices can be found in the [adding new comp
8787
Because this project exports a library that will be used by other projects, it is important that updates follow a set of standard practices. When you PR your changes, several hooks will run to check and format changed files. In order to be eligible for merging, all branches must pass the following automation.
8888

8989
- Code format and linting are enforced with automations.
90-
- We use the following tools:
90+
- We use the following tools:
9191
- [Prettier](https://prettier.io/)
9292
- [TypeScript compilation](https://www.typescriptlang.org/)
9393
- [eslint](https://eslint.org/)
@@ -127,7 +127,7 @@ It's important to test your changes in a real-life application instance, especia
127127

128128
Yarn provides the [`yarn link` command](https://classic.yarnpkg.com/en/docs/cli/link/) to symlink a specific package to a local version of that package. This can be very helpful if you're trying to do development in ReactUSWDS & test changes in an application simultaneously.
129129

130-
To use this, first run `yarn link` in your local ReactUSWDS directory:
130+
To use this, first run `yarn build && yarn link` in your local ReactUSWDS directory:
131131

132132
```
133133
cd /path/to/react-uswds

0 commit comments

Comments
 (0)