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: docs/contributing.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,16 +27,15 @@ We welcome contributions in the form of comments, issues, or pull requests with
27
27
## Environment setup
28
28
29
29
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).
31
31
- 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.
32
32
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.
37
33
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.
39
37
38
+
2. Use [yarn](https://yarnpkg.com) to manage JS packages.
40
39
-[Install yarn](https://yarnpkg.com/en/docs/install) if you do not already have it.
41
40
- 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.
42
41
@@ -56,6 +55,7 @@ These should all be run from within the project directory.
56
55
-`yarn build`
57
56
- Builds files from `/src` and outputs to `/lib` using webpack and UMD library target
58
57
-`yarn build:watch` is also available
58
+
59
59
## Development
60
60
61
61
### Working on an issue
@@ -87,7 +87,7 @@ More guidance for preferred React practices can be found in the [adding new comp
87
87
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.
88
88
89
89
- Code format and linting are enforced with automations.
@@ -127,7 +127,7 @@ It's important to test your changes in a real-life application instance, especia
127
127
128
128
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.
129
129
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:
0 commit comments