Skip to content

Commit

Permalink
docs: updates CONTRIBUTING.md with minor fixes
Browse files Browse the repository at this point in the history
There is a broken link and the information about how the linting
checks could be run are unclear.

Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed Jan 5, 2024
1 parent 1566b6e commit 359d8e4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 359d8e4

Please sign in to comment.