Contributing to Docling Studio

Thank you for your interest in contributing to Docling Studio! This guide will help you get started.

Getting Started

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/<your-username>/Docling-Studio.git
cd Docling-Studio

Create a branch for your work:
```
git checkout -b feature/my-feature
```

Development Setup

Backend (Python 3.12+)

cd document-parser
python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
pip install ruff pytest pytest-asyncio httpx  # dev tools
uvicorn main:app --reload --port 8000

Frontend (Node 20+)

cd frontend
npm install
npm run dev

Code Quality

Backend — Ruff

We use Ruff for linting and formatting Python code.

cd document-parser
ruff check .          # lint
ruff check . --fix    # lint with auto-fix
ruff format .         # format

Frontend — TypeScript + ESLint + Prettier

cd frontend
npm run type-check          # type check (vue-tsc)
npx eslint src/             # lint
npx prettier --check src/   # check formatting
npx prettier --write src/   # auto-format

Running Tests

# Backend (99 tests)
cd document-parser
pytest tests/ -v

# Frontend (81 tests)
cd frontend
npm run test:run

All tests must pass before submitting a PR.

Submitting Changes

Commit with clear, descriptive messages
Push your branch to your fork
Open a Pull Request against main
Describe what changed and why in the PR description
Ensure CI passes (tests + build)

Pull Request Guidelines

Keep PRs focused — one feature or fix per PR
Add tests for new functionality
Update documentation if behavior changes
Follow existing code style and conventions

Reporting Issues

Use GitHub Issues to report bugs or request features
Include steps to reproduce for bugs
Mention your OS, Python/Node version, and Docker version if relevant

License

By contributing, you agree that your contributions will be licensed under the MIT License.

2.2 KiB Raw Blame History