Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 1.58 KB
Raw

Contributing to DocForge

Thank you for helping improve DocForge — document ingest for RAG and AI agents.

Getting started

  1. Fork github.com/bdeeps/docforge
  2. Clone your fork and create a branch: git checkout -b feat/my-change
  3. Install dev dependencies:
python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
cd web && npm install && cd ..
  1. Run tests before opening a PR:
pytest
ruff check src tests

What to contribute

  • Bug fixes — converters, chunking edge cases, deployment paths
  • Format support — new document types (with tests)
  • Agent docs — improve AGENTS.md, FAQ, MCP references
  • Integrations — vector store export formats, webhooks
  • UI — web upload experience, accessibility

Pull request guidelines

  • Keep changes focused — one concern per PR
  • Add or update tests for behavior changes
  • Update relevant docs (README.md, docs/, AGENTS.md)
  • Follow existing code style (ruff, type hints where present)

Reporting issues

Use GitHub Issues with:

  • Steps to reproduce
  • Expected vs actual behavior
  • DocForge version / commit
  • Environment (local, Railway, Docker)

Agent documentation

If your change affects agents or MCP, also update:

  • AGENTS.md
  • docs/agents/mcp.md or docs/agents/rest.md
  • .cursor/skills/docforge/SKILL.md
  • src/docforge/agent_manifest.py (if endpoints/tools change)

Code of conduct

Be respectful and constructive. We're building tools for the open AI/RAG community.