Files
docling-core/CONTRIBUTING.md
Cesar Berrospi Ramis 2a78701b3f chore: update pre-commit hooks and development dependencies (#638)
* chore: update pre-commit hooks and development dependencies

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

* docs: update CONTRIBUTING after pre-commit hook changes

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>

---------

Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>
2026-06-15 17:07:34 +02:00

75 lines
2.3 KiB
Markdown

## Contributing In General
Our project welcomes external contributions. If you have an itch, please feel
free to scratch it.
For more details on the contributing guidelines head to the Docling Project [community repository](https://github.com/docling-project/community).
## Developing
### Usage of uv
We use [uv](https://docs.astral.sh/uv/) as package and project manager.
#### Installation
To install `uv`, check the documentation on [Installing uv](https://docs.astral.sh/uv/getting-started/installation/).
#### Create an environment and sync it
You can use the `uv sync` to create a project virtual environment (if it does not already exist) and sync
the project's dependencies with the environment.
```bash
uv sync --all-extras
```
#### Use a specific Python version (optional)
If you need to work with a specific version of Python, you can create a new virtual environment for that version
and run the sync command:
```bash
uv venv --python 3.12
uv sync --all-extras
```
More detailed options are described on the [Using Python environments](https://docs.astral.sh/uv/pip/environments/) documentation.
#### Add a new dependency
Simply use the `uv add` command. The `pyproject.toml` and `uv.lock` files will be updated.
```bash
uv add [OPTIONS] <PACKAGES|--requirements <REQUIREMENTS>>
```
### Code style guidelines
We use the following tools to enforce code style:
- [Ruff](https://docs.astral.sh/ruff/), to format and lint code
- [MyPy](https://mypy.readthedocs.io), as static type checker
A set of styling checks, as well as regression tests, are defined and managed through the [pre-commit](https://pre-commit.com/) framework. To ensure that those scripts run automatically before a commit is finalized, install `pre-commit` on your local repository:
```bash
uv run pre-commit install
```
To run the checks on-demand, type:
```bash
uv run pre-commit run --all-files
```
### Documentation
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.
The documentation pages are stored in [docs](./docs/) folder and are updated at every commit, as part of the `pre-commit` check hooks.
To generate the documentation on-demand, run:
```bash
uv run python -m docling_core.utils.generate_docs docs
```