Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.48 KB
Raw

Contributing to Tracegate

Tracegate is currently an MVP focused on making GitHub Copilot hook behavior inspectable before local execution is enabled. Contributions are welcome, but changes should preserve the project's safety model and deterministic fixture-first workflow.

Before You Start

  • Open an issue for significant feature work before starting implementation.
  • Keep changes aligned with the MVP scope unless the issue explicitly expands it.
  • Do not weaken the default dry-run behavior.

Development Setup

npm install
npm run check
npm run dev

Project Expectations

  • Keep the TUI safe by default. Local execution must remain explicit.
  • Prefer deterministic fixtures and repeatable outputs over ad hoc examples.
  • Add or update tests for config validation, payload normalization, simulation behavior, and UI state changes when those areas are modified.
  • Keep docs consistent with actual MVP behavior.
  • Avoid unrelated refactors in the same change.

Pull Requests

  • Use focused commits and a clear PR description.
  • Include the user-facing or developer-facing impact.
  • Call out safety implications when a change touches command execution or hook parsing.
  • Update docs or examples when UI behavior or output changes.

Areas That Need Help

  • Better fixture coverage for multi-step hook chains
  • More export and reporting capabilities from the TUI
  • Improved inspection flows for config, payload, and trace data
  • Documentation polish for setup, demos, and architecture