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
If you are coming from development from a different repository, you may need to install a new version of node in `nvm`. If you see an error message to this effect, [refer to the nvm docs](https://github.com/nvm-sh/nvm?tab=readme-ov-file#usage) for installing the missing node version and for directions on switching between versions of `node` using `nvm`. Once `nvm` is installed you can switch to the repository defined node and pnpm versions by re-running the [setup/install step](#setup) above.
51
58
52
-
If you actively work/switch between different repositories run `nvm use && corepack prepare --activate` in the root of the project to ensure use of the correct node/pnpm version.
59
+
If you actively switch between different repositories, run `nvm use && corepack prepare --activate` in the root of the project to ensure use of the correct node/pnpm version.
53
60
54
61
### Building
55
62
56
-
Both the top-level repository and each project has a set of standardized npm scripts. To build and test all projects run `pnpm run ci` at the root of repository.
63
+
Both the top-level repository and each project have a set of standardized npm scripts. To build and test all projects, run `pnpm run ci` at the root of the repository.
57
64
58
65
#### Top-Level Repository
59
66
@@ -63,22 +70,26 @@ Both the top-level repository and each project has a set of standardized npm scr
63
70
64
71
#### Individual Projects
65
72
73
+
Common project scripts include:
74
+
66
75
-`dev`: run in watch mode
67
76
-`build`: run project/library build
68
77
-`test`: run unit tests
69
78
-`test:lighthouse`: run lighthouse performance tests
70
79
-`test:visual`: run playwright visual regression tests
71
80
-`test:axe`: run axe tests for a11y
72
81
73
-
To learn in detail how the repo is built and run see our [build README.md](https://github.com/NVIDIA/elements/blob/main/build/README.md).
82
+
The available scripts vary by project. Check the project's `package.json` before running project-specific commands.
83
+
84
+
To learn in detail how the repo is built and run see our [build system documentation](https://github.com/NVIDIA/elements/blob/main/projects/internals/BUILD.md).
74
85
75
86
## Workflow
76
87
77
88
Before creating a branch or pull request be sure to make a [new issue or feature request](https://github.com/NVIDIA/elements/issues/new) first for the team to evaluate. This will help ensure that your work aligns with the goals of the project and that you are not duplicating effort.
78
89
79
90
### Create a Branch
80
91
81
-
Use a descriptive branch name with a prefix. Example `feature/bug-fix`.
92
+
Use a descriptive branch name with the `topic/`prefix. Example `topic/bug-fix`.
82
93
83
94
```shell
84
95
git checkout -b topic/bug-fix
@@ -91,7 +102,7 @@ Once your branch is created, make your source code changes. Once your changes ar
91
102
The repo uses [Semantic Release](https://semantic-release.gitbook.io/semantic-release/) to manage package changes. Commit messages determine the type of release on merge. [Commit Lint](https://commitlint.js.org/) will enforce and catch any formatting issues in commits.
92
103
93
104
```shell
94
-
git commit -a -m "fix(core): disabled multi-select"
105
+
git commit -a -m "fix(core): disable multi-select" -m "Signed-off-by: Your Name <you@example.com>"
Keep commit names focused on the changes you are making as the commit message is what is used to determine the next release and generated changelog notes.
117
137
@@ -123,7 +143,7 @@ Once you have committed your changes to your branch locally, push them to the re
123
143
git push --set-upstream origin topic/bug-fix
124
144
```
125
145
126
-
Open a new [Pull Request](https://github.com/NVIDIA/elements/pulls) in GitHub. Request review from the team members and apply the appropriate labels it the GitHub UI for example, `type:fix` and `scope:elements`.
146
+
Open a new [Pull Request](https://github.com/NVIDIA/elements/pulls) in GitHub. Request review from the team members and apply the appropriate labels in the GitHub UI, for example, `type:fix` and `scope(core)`.
0 commit comments