Guidelines
Guidelines
Rules for writing and testing Infrahub Sync code, including adapter rules, repository-wide testing, and secret redaction. For how the system works, see Knowledge; for step-by-step procedures, see Guides.
Adapters
- Writing an adapter — structure, typing, error handling, logging, optional dependencies, and secret handling for a connector.
- Testing adapters — the test coverage every adapter must ship and the conventions those tests follow.
Repository-wide
- Testing — what makes a test worth having: mutation kill as the acceptance criterion, asserting a negative, and reviewing a remediation over its own diff.
- Testing tiers — which command runs which tier, what each one needs before it proves anything, what it writes, and why a skipped check is not a pass.
- Secret redaction — rules for any failure path that crosses a process boundary: where to sanitize, what to collect, and how over-collection fails.
Related
- Knowledge — the architecture these rules apply to.
- Repository tour — where to find the code for each part of the system.
- Adding an adapter — the procedure for implementing and testing a new adapter.
- Decision records — the decisions behind these rules.
- Constitution — the principles these rules serve.