Skip to content

Commit 50ce815

Browse files
authored
Enhance README with formatting, linting, and testing info
Added sections for formatting, linting, and testing instructions.
1 parent d30aff6 commit 50ce815

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

documentation_developer/README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,32 @@ To launch the application, follow these steps:
2222
4. Launch the application:
2323
```sh
2424
npm run dev
25-
```
25+
```
26+
27+
## Formatting and Linting
28+
29+
When you push your changes to the repository, one of the Github workflows automatically performs a linting check, as well as an automated formatting.
30+
To run the linting or formatting by yourself, type:
31+
32+
```sh
33+
npm run lint
34+
npm run prettier
35+
```
36+
37+
To avoid/fix merge conflicts due to the automated formatting, you can do either:
38+
39+
1. Call `npm run prettier` locally before you push.
40+
2. Or before you push a second time, first pull the new formatting changes.
41+
3. Or `rebase` and simply overwrite all formatting changes of the remote with your current code. The formatting will anyways be executed again.
42+
43+
## Tests
44+
45+
For detailed testing descriptions, see [the testing documentation](TESTING.md)
46+
47+
In short, run unit tests and end-to-end tests the following way:
48+
49+
50+
```sh
51+
npm run test
52+
npm run test:e2e
53+
```

0 commit comments

Comments
 (0)