diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb45244..f7eb177 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,8 +12,8 @@ ## Repository structure -- **src/`aki_prj23_transparenzregister`**: - - This sub-folder/`package` contains several subdirectories: +- **`src/aki_prj23_transparenzregister`**: + - This sub-folder / `package` contains several subdirectories: - `ai`: - Houses AI models and pipelines, including NER and sentiment analysis. - `config`: @@ -53,7 +53,7 @@ We decided to use english on everything close to code but will write longer text german. ## Pre-Commit Usage -- [Install pre-commit](https://pre-commit.com/#install) `pre-commit install --install-hooks -t post-checkout -t post-merge -t pre-commit` +- [Install pre-commit](https://pre-commit.com/#install): `pre-commit install --install-hooks -t post-checkout -t post-merge -t pre-commit` - the following code format rules are so enforced: - Whitespace formatting: