Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md to note Python checks
Browse files Browse the repository at this point in the history
  • Loading branch information
jbms committed Oct 6, 2023
1 parent 1f08a40 commit c11f001
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
17 changes: 15 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,28 @@ frustration later on.
All submissions, including submissions by project members, require review.

### Coding Style
For consistency, please ensure that all files are formatted by `clang-format` using the [.clang-format](.clang-format) style file. You can verify this by running:
For consistency, please ensure that all TypeScript/JavaScript files
are formatted by `clang-format` using the
[.clang-format](.clang-format) style file. You can verify this by
running:

```shell
npm run gulp check-format
```
To reformat all source files, run:
To reformat all TypeScript/JavaScript source files, run:
```shell
npm run gulp format
```

Python code is linted and formatted using
[ruff](https://github.com/astral-sh/ruff) and typechecked using
[mypy](https://mypy-lang.org/). To verify, run:

```shell
pip install nox
nox -s lint format mypy
```

### The small print
Contributions made by corporations are covered by a different agreement than
the one above, the
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ exclude = [
"^src/",
"/guide_video_recorder/",
"^docs/",
"^build/",
]

[[tool.mypy.overrides]]
Expand Down

0 comments on commit c11f001

Please sign in to comment.