generated from amosproj/amos202Xss0Y-projname
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove README section on pre-commit hooks
Signed-off-by: Tims777 <[email protected]>
- Loading branch information
Showing
1 changed file
with
1 addition
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,7 +18,7 @@ SPDX-FileCopyrightText: 2023 Berkay Bozkurt <[email protected]> | |
|
||
For build, user, design documentations (and more) please refer to our dedicated [Documentation Page](https://amosproj.github.io/amos2023ws06-sales-lead-qualifier). | ||
|
||
### License | ||
## License | ||
|
||
This project is operated under an MIT license. Every file must contain the REUSE-compliant license and copyright declaration: | ||
|
||
|
@@ -28,21 +28,3 @@ This project is operated under an MIT license. Every file must contain the REUSE | |
# SPDX-License-Identifier: MIT | ||
# SPDX-FileCopyrightText: 2023 | ||
``` | ||
|
||
### Pre-Commit Hooks | ||
|
||
This repository uses `pre-commit` hooks to ensure a consistent and clean file organization. Each registered hook will be executed when committing to the repository. To ensure that the hooks will be executed they need to be installed using the following command: | ||
|
||
```bash | ||
pre-commit install | ||
``` | ||
|
||
The following things are done by hooks automatically: | ||
|
||
- formatting of python files using black and isort | ||
- formatting of other files using prettier | ||
- syntax check of JSON and yaml files | ||
- adding new line at the end of files | ||
- removing trailing whitespaces | ||
- prevent commits to `dev` and `main` branch | ||
- check adherence to REUSE licensing format |