Phase 7 — Cross-phase Quality, Typing, Logging, and Contributor Docs

[Swiftburn]

Phase 7 — Cross-phase Quality, Typing, Logging, and Contributor Docs

Purpose

Raise code quality across modules: types, logging, error handling, contributor docs, and changelog.

Tasks

• 7.1 Add type hints and run static checks

  • Work: Add type annotations to all public functions and classes in new modules. Add mypy config (optional).
  • Tests: scripts/run-typecheck.sh or CI job with mypy.
  • DoD: no new files exported without basic typing; typecheck job runs.

• 7.2 Standardized logging utility

  • File: src/core/logging.py or extend src/core/config.py
  • Work: Provide get_logger(name) that sets levels, structured logging config (time, level, module). Ensure modules use it.
  • DoD: consistent logger across repo and log formatting documented.

• 7.3 Error handling strategy & retries

  • Work: Add guidelines for model load failures, transient network errors, permission errors for capture. Implement retry/backoff helper in src/core/utils.py.
  • Tests: tests/test_retries.py for backoff logic.
  • DoD: helper implemented and used where appropriate.

• 7.4 CONTRIBUTING.md and PR template

  • Files: CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md
  • Work: Add onboarding, how to run tests, commit message guidelines, and issue/PR checklist.
  • DoD: docs exist and linked from README.

• 7.5 CHANGELOG and release checklist

  • File: CHANGELOG.md, RELEASE.md
  • Work: Template for releasing, tagging, and packaging steps.
  • DoD: release checklist available.

Notes

• These tasks improve long-term maintainability and CI health.