Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (36 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.35 KB
Raw

Contributing to Document Intelligence API

Thank you for your interest in contributing! Contributions are what make the open-source community a great place to learn and grow.

How to Contribute

Reporting Bugs

  1. Check existing issues first.
  2. Open a bug report with a clear title and description.
  3. Include reproduction steps, expected vs. actual behavior, and your environment.

Suggesting Features

  1. Check existing feature requests first.
  2. Open a feature request explaining the use case and expected behavior.

Pull Requests

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/amazing-feature).
  3. Make your changes.
  4. Run tests and linting (see below).
  5. Commit with a conventional message (feat:, fix:, docs:, refactor:, test:, chore:).
  6. Push and open a Pull Request.

Development Setup

git clone https://github.com/DavidEscotoDev/doc-intel-api.git
cd doc-intel-api
pip install -e ".[dev]"

Code Style

  • Linted with ruff.
  • Format: ruff format .
  • Type-check: mypy .
  • Tests: pytest

Testing

Run the full suite before opening a PR:

ruff check .
pytest tests/ -v

License

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