Skip to content

[FEAT]: Developer setup guide and enhanced CONTRIBUTING.mdΒ #244

@kasimlohar

Description

@kasimlohar

πŸ“ Description

New contributors currently lack a comprehensive setup guide. The CONTRIBUTING.md lists prerequisites (Docker, Compose, Make) but stops without providing actual setup steps. The docs/ directory has only db.md and docker.md β€” there is no cross-platform developer onboarding guide.

πŸ’‘ Rationale

Multiple issues report setup-related problems that could be prevented with better documentation:

A central setup guide consolidating these solutions would reduce repeated issue filings and help new contributors get started faster.

πŸ› οΈ Proposed Solution

  1. Enhance CONTRIBUTING.md β€” add development setup instructions, testing commands (pytest), branch naming conventions (feat/, fix/, docs/), commit message guidelines, project structure overview, and useful links.
  2. Create docs/SETUP.md β€” comprehensive cross-platform (Windows, macOS, Linux) setup guide with:
    • Docker setup (5 steps) and local setup (6 steps)
    • Environment variable reference (OLLAMA_HOST, PYTHONPATH)
    • 6 common errors with fixes, each linked to the relevant issue
    • Database reset instructions
    • Architecture pipeline overview
  • Documentation update in docs/
  • Update to CONTRIBUTING.md

βœ… Acceptance Criteria

  • CONTRIBUTING.md includes Quick Start steps for both Docker and local development
  • docs/SETUP.md covers Windows, macOS, and Linux setup
  • Common errors reference their corresponding GitHub issues
  • All internal and external links resolve correctly

πŸ“Œ Additional Context

Documentation-only changes β€” no application code is modified.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions