Skip to content

Commit

Permalink
Remove README section on pre-commit hooks
Browse files Browse the repository at this point in the history
Signed-off-by: Tims777 <[email protected]>
  • Loading branch information
Tims777 authored Feb 14, 2024
1 parent cb97b49 commit 7ffc7e7
Showing 1 changed file with 1 addition and 19 deletions.
20 changes: 1 addition & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

0 comments on commit 7ffc7e7

Please sign in to comment.