Skip to content

Commit 85a1889

Browse files
author
Florian Schwarb
committed
Modified CONTRIBUTING.md such that black / isort are replaced by ruff
Signed-off-by: Florian Schwarb <[email protected]>
1 parent 7e6ef81 commit 85a1889

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ uv add [OPTIONS] <PACKAGES|--requirements <REQUIREMENTS>>
4747

4848
We use the following tools to enforce code style:
4949

50-
- isort, to sort imports
51-
- Black, to format code
50+
- Ruff, to format and lint code
5251
- Flake8, to lint code
5352
- autoflake, to remove unused variables and imports
5453
- [MyPy](https://mypy.readthedocs.io), as static type checker
@@ -65,9 +64,6 @@ To run the checks on-demand, type:
6564
uv run pre-commit run --all-files
6665
```
6766

68-
Note: Checks like `Black` and `isort` will _fail_ if they modify files. This is because `pre-commit` doesn't like to see files modified by their hooks. In these cases, `git add` the modified files and `git commit` again.
69-
70-
7167
### Documentation
7268

7369
We use [JSON Schema for Humans](https://github.com/coveooss/json-schema-for-humans) to generate Markdown pages documenting the JSON schema of the Docling objects.

0 commit comments

Comments
 (0)