From 7ffc7e70745ba655631589a76aa30190495687f8 Mon Sep 17 00:00:00 2001 From: Tims777 Date: Wed, 14 Feb 2024 15:29:05 +0100 Subject: [PATCH] Remove README section on pre-commit hooks Signed-off-by: Tims777 --- README.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/README.md b/README.md index 5af6358..a802cf3 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ SPDX-FileCopyrightText: 2023 Berkay Bozkurt 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