Skip to content

Commit f024b71

Browse files
authored
Update CONTRIBUTING.md
add more infos on code style, eslint and tests
1 parent cd35a17 commit f024b71

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,35 @@ Please report any problems you've had with the setup instructions!
8282
## Code Style
8383

8484
To make sure the code changes only where it should, we are using prettier to unify the code style.
85+
86+
- You can format all files at once by running `pnpm prettier` from the project root
87+
- Run `pnpm format-check` from the project root to check if all files are well formatted
88+
8589
If you use VSCode, you can
8690

8791
1. install [the prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
8892
2. open command palette and run "Format Document With..."
8993
3. Choose "Configure Default Formatter..."
9094
4. Select prettier
9195

96+
## ESLint
97+
98+
To prevent unwanted runtime errors, this project uses [eslint](https://eslint.org/).
99+
100+
- You can check for lint errors by running `pnpm lint`
101+
102+
There are also eslint extensions / plugins for most editors.
103+
104+
## Running Tests
105+
106+
- Run all tests with `pnpm test`
107+
- Run all tests with UI using `pnpm test-ui`
108+
109+
## Running all CI Checks
110+
111+
When opening a PR, the CI runner will automatically check the code style and eslint, as well as run all tests.
112+
You can run the same check with `pnpm check`
113+
92114
## Package Workflow
93115

94116
The project is split into multiple [packages](https://github.com/tidalcycles/strudel/tree/main/packages) with independent versioning.

0 commit comments

Comments
 (0)