Documentation and CI follow-ups

[patrick91]

Objective

Complete documentation and enhance CI pipeline for comprehensive testing.

Tasks

Documentation

• Create TESTING.md - Testing guide for contributors
• Update README.md with:
  • GitHub integration setup instructions
  • submit command examples
  • get command examples
  • checkout command usage
  • sync command workflow
  • Stacked PR workflow guide
• Create CONTRIBUTING.md - Development guide
• Document test organization (unit/integration/e2e)
• Document how to add new commands with tests
• Add architecture overview (metadata, GitHub client)
• Add troubleshooting guide
• Add FAQ section
• Document environment variables (GITHUB_TOKEN, etc.)

CI Pipeline Enhancements

• Configure pytest-xdist for parallel test execution
• Add test job matrix:
  • Python versions: 3.10, 3.11, 3.12, 3.13, 3.14
  • OS: Ubuntu, macOS, Windows
  • Git versions: 2.30+, latest
• Add coverage reporting with codecov
• Add coverage badge to README
• Add test result summary to PR comments
• Configure dependabot for dependency updates
• Add performance benchmarking job
• Add linting job (ruff)
• Add type checking job (mypy, if applicable)
• Run e2e test script in CI

Release Preparation

• Add CHANGELOG.md
• Document versioning scheme (semver)
• Add release workflow (GitHub Actions)
• Prepare v1.0.0 release notes

Code Quality

• Ensure 90%+ test coverage
• Add type hints to all functions
• Document all public APIs
• Add docstrings where missing

Acceptance Criteria

• Documentation complete and accurate
• CI tests run on all supported platforms
• Coverage >90% and tracked in CI
• All code properly documented
• Release process documented
• Contributing guide helps new developers

[patrick91]

Current status as of 2026-03-19:

Already in place:

• CI runs lint, type checks, unit tests with coverage, and Playwright e2e jobs.

Still missing from this issue:

• contributor/testing/release docs
• matrix builds / codecov / dependabot / release workflow
• broader documentation polish

Partially stale; worth narrowing to the remaining docs/CI work.

[patrick91]

Triaged against main at 52da8bd.

Newly in place since the earlier status:

• CHANGELOG.md exists.
• Release workflows exist: .github/workflows/release.yml and .github/workflows/release-check.yml.
• The test workflow runs ruff, formatting, type checks via ty, unit tests with coverage, and Playwright e2e tests.
• README/site polish covers the main submit/stack workflow and token requirements.

Still open:

• No TESTING.md or CONTRIBUTING.md.
• No Python/OS/Git matrix; CI currently runs on Ubuntu with Python 3.14.
• No Codecov/dependabot/perf job/PR comment summary.
• The requested standalone e2e script is still absent.
• Broader contributor docs, architecture docs, troubleshooting, FAQ, and env-var docs still need work.