44r0n7/privacy.sexy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve existing documentation

Browse Source 
Improve documentation for different markdown documentation files. Goal
is to simplify and make the language and content more clear.
This commit is contained in:
undergroundwires
2022-01-30 13:15:34 +01:00
parent 1bcc6c8b2b
commit db47440d47
7 changed files with 159 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/development.md
View File

@@ -5,7 +5,7 @@ Before your commit, a good practice is to:
1. [Run unit tests](#testing)
2. [Lint your code](#linting)
You could run other types of tests as well, but they may take longer time and overkill for your changes. All tests are executed inside a pull request.
You could run other types of tests as well, but they may take longer time and overkill for your changes. Automated actions executes the tests for a pull request or change in the main branch. See [ci-cd.md](./ci-cd.md) for more information.
## Commands
@@ -22,6 +22,8 @@ You could run other types of tests as well, but they may take longer time and ov
- Interactive mode with GUI: `npm run test:e2e`
- Headless mode without GUI: `npm run test:e2e -- --headless`
📖 Read more about testing in [tests](./tests.md).
### Linting
- Lint all (recommended 💡): `npm run lint`
@@ -48,4 +50,4 @@ You could run other types of tests as well, but they may take longer time and ov
You should use EditorConfig to follow project style.
For Visual Studio Code, recommended extensions are defined in [`.vscode/extensions.json`](./../.vscode/extensions.json).
For Visual Studio Code, [`.vscode/extensions.json`](./../.vscode/extensions.json) includes list of recommended extensions.