Skip to content

Commit 58439d7

Browse files
authored
Update README.dev.md
1 parent 89a5971 commit 58439d7

1 file changed

Lines changed: 6 additions & 22 deletions

File tree

README.dev.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,18 @@ The command below will build the application and save the output in `docs/` fold
4646
npm run build
4747
```
4848

49-
## Debugging
49+
## Debugging (TODO)
5050

51-
- Relevant issues:
52-
- ...
5351
- Stepping through the code
5452
- Inspection of variables
5553
- Evaluating expressions
5654

57-
## Tests
55+
- [Vue.js devtools - Beta](https://chrome.google.com/webstore/detail/vuejs-devtools/ljjemllljcmogpfapbkkighbhhppjdbg?hl=en)
56+
- [Vue.js devtools](https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
5857

59-
- Relevant issues:
60-
- ...
61-
- Additional package requirements
62-
- What types of tests are there (unit tests, live tests, cli tests)?
63-
- What tests are there?
64-
- What is the strategy/philosophy for testing in the project? For example, TDD or BDD; testing of public v. private functions, etc.
65-
- What testing concepts are used: mocks, fixtures, contracts, scenarios, features, etc.
66-
- Directory naming / file structure patterns: e.g. file naming schemes, predefined directory tree layouts, test classes v. test functions, etc.
67-
- Coverage calculation and where to see the results of static analysis
58+
## Tests
6859

69-
We use Jest for unit tests. To run unit tests (`test/jest/__tests__/**/*.jest.spec.ts`)
60+
We use `Jest` for unit tests. The unit tests can be found under `test/jest/__tests__/` folder.
7061

7162
You can run the test with
7263

@@ -82,14 +73,6 @@ npm run test:unit:ui
8273

8374
## Linting and formatting
8475

85-
- Relevant issues:
86-
- ...
87-
- What linters are being used in the project
88-
- How to run them
89-
- Where the configuration is coming from
90-
- How to enable linting tools in the editor
91-
- How to configure git pre-commit hooks
92-
9376
```shell
9477
npm run lint
9578
```
@@ -141,3 +124,4 @@ Links to documentation or tutorials related to technologies/tools we use in the
141124
- [Husky](https://typicode.github.io/husky/#/): Automaticly runs checks before pushing changes to GitHub.
142125
- [Jest](https://jestjs.io/): Testing framework to run unit tests and perform test assertions.
143126
- [ESLint](https://eslint.org/): To get constistent code style and prevent errors the industry standard linter ESLint is used.
127+
- [Majestic Web UI](https://github.com/Raathigesh/majestic): Web UI for unit tests using Jest

0 commit comments

Comments
 (0)