Skip to content

docs: Add TESTING.md and DEVELOPMENT_SETUP.md guides #34

Description

@db-tycoon-stephen

Problem

No contributor guides for testing or local development setup. New developers don't know how to write tests or get started.

Proposed Solution

TESTING.md

  • How to run tests (uv run pytest)
  • Test structure and conventions
  • How to write new tests (patterns, fixtures, mocking Snowflake)
  • Integration vs unit test guidelines
  • Coverage reporting

DEVELOPMENT_SETUP.md

  • Prerequisites (Python, UV, openssl)
  • Clone and install steps
  • Environment configuration (.env setup)
  • IDE configuration (VS Code recommended settings)
  • Pre-commit hook setup
  • Common development workflows

Acceptance Criteria

  • docs/contributing/TESTING.md created
  • docs/contributing/DEVELOPMENT_SETUP.md created
  • Linked from CONTRIBUTING.md and README

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions