Skip to content

Commit 04bf335

Browse files
committed
feat(readme): Updates to the readme to verify 1 review security
1 parent bfc0d33 commit 04bf335

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,30 @@ tests are run locally. The output is displayed.
2828
The `.github` folder contains the following:
2929

3030
1. The test run "counter" scripts
31+
.github/scripts
3132
2. The "counter" file
33+
.github/counter
3234
3. The github action work flow scripts
35+
.github/workflows
3336
4. The github PR templates
37+
.github/pull_request_template.md
38+
39+
## Local pipeline
40+
41+
The local pipeline pipeline is managed via husky
42+
43+
1. The pre-commit requirements are:
44+
- linting on the staged files passes
45+
- .husky/pre-commit
46+
2. The pre-push requirements are:
47+
- All tests pass
48+
- Test coverage is met
49+
50+
## Volta
51+
52+
OSF uses volta (https://volta.sh/) to manage node and npm versions inside of the repository
53+
54+
## Commitlint
55+
56+
OSF use commitlint (https://www.npmjs.com/package/commitlint) to standardize the commit messages.
57+
Please review the commitlint conventions (@commitlint/config-conventional/README.md)

0 commit comments

Comments
 (0)