You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27Lines changed: 27 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -70,3 +70,30 @@ Submit a pull request via the normal GitHub UI.
70
70
## After Submitting
71
71
72
72
- Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.
73
+
74
+
## Project-specific Developer Information
75
+
76
+
### Pre-Commit Hooks with Husky
77
+
78
+
In this project, we have set up pre-commit hooks using Husky to ensure code quality and consistency before each commit. These hooks run a series of checks and tests to ensure that only clean and properly formatted code is committed to the repository.
79
+
80
+
**NOTE:** For further Pre-Commit Hooks, please alter the [husky configuration](.husky/pre-commit).
81
+
82
+
#### How it Works
83
+
84
+
1.**Husky Configuration**: We've configured Husky, a Git hook manager, to execute specific scripts before each commit.
85
+
86
+
2.**Linter Check**: First, the linter is run to check your code for any syntax or style issues. This ensures that your code follows a consistent coding style.
87
+
88
+
3.**Code Formatting:** Next, Prettier is used to automatically format your code according to the predefined coding style rules.
89
+
90
+
4.**Jest Tests:** Finally, the Jest tests are executed to validate the functionality of your code. If any tests fail, the commit process will be aborted.
91
+
92
+
## How to develop this VSCode-Extension
93
+
94
+
0. Clone this repository.
95
+
1. Run ```npm install```.
96
+
2. Run ```npm run watch``` to start Dev-Mode. This opens a separate Window with a VSCode-Environment running the Extension for development.
97
+
3. Refer to the Welcome Page or [README](README.md) to add target devices for testing.
0 commit comments