From 359d8e4a711b812ffc2dccf05e8a2306dba89847 Mon Sep 17 00:00:00 2001 From: Jennifer Power Date: Wed, 3 Jan 2024 16:27:47 -0500 Subject: [PATCH] docs: updates CONTRIBUTING.md with minor fixes There is a broken link and the information about how the linting checks could be run are unclear. Signed-off-by: Jennifer Power --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e617ac8c..d1e661dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,14 +75,14 @@ For workflow diagrams, see the [diagrams](./docs/diagrams/) under the `docs` fol ### Format and Styling This project uses `black` and `isort` for formatting and `flake8` for linting. You can run these commands to format and lint your code. -They are also run as part as a pre-commit hook. +Linting checks can be run as a pre-commit hook and are verified in CI. ```bash make format make lint ``` -For non-Python files, we use [Megalinter](https://github.com/oxsecurity/megalinter) to lint in a CI task. See [megalinter.yaml](./.github/megalinter.yaml) for more information. +For non-Python files, we use [Megalinter](https://github.com/oxsecurity/megalinter) to lint in a CI task. See [megalinter.yaml](./.mega-linter.yml) for more information. ### Type Hints and Static Type Checking