adr

Architecture Decision Records (ADRs)

• A template to create new ADRs is available here.
• Submit a pull request to add a new ADR to this repository.
  • Use the adr folder as the base path for the ADR.
  • Label the ADR
    • Use the ADR and ADR/under-discussion label for the pull request.
    • If the ADR is for a purely internal change¹, use the ADR/internal label.
  • Name your ADR file using the following convention: ADR-NNNN-title.md, where NNNN is the next sequential number and title is a short, lower-case, dash-separated description of the ADR.
  • Place any external documents referenced by the ADR in the adr/assets folder.

Current ADRs

List of ADRs currently in discussion.

Approved ADRs

• ADR-0001: TrustyAI external library integration
• ADR-0002: Metrics and XAI namespaces

Footnotes

1. An internal change is one that does not affect the external API of the TrustyAI service or the deployment architecture. ↩