Developers#

Welcome. This section is for contributors who want to develop, maintain, or extend DepDigest.

The path below is intentionally ordered. If you follow it in sequence, you will go from a local setup to production-ready contributions with the same conventions used in this repository.

If your goal is integrating DepDigest into your own package (not contributing to this repository), start in the User section.

Developer Path#

  1. Contributing Workflow: branch, commit, and PR expectations.

  2. Development Environment: local setup, test commands, and docs build.

  3. Architecture: how DepDigest is structured and why key design decisions were made.

  4. Implementation Patterns: how to implement features without breaking runtime behavior.

  5. SMonitor for Contributors: diagnostics contract and emission rules.

  6. Testing and Coverage: required test strategy and coverage workflow.

  7. API Stability: public contract guarantees and compatibility rules.

  8. Deprecation and Support Policy: lifecycle rules for compatibility-sensitive changes.

  9. Editorial Guide: style and structure rules for docs and developer-facing text.

  10. Release and Versioning: practical release flow and tagging checks.

  11. Contributor Checklist: final pre-PR and pre-release checklist.

Canonical References#

  • Project-level implementation contract: DEPDIGEST_GUIDE.md

  • SMonitor integration authority for this repository: SMONITOR_GUIDE.md

  • Internal design notes used to build this section: devguide/