Architectural Decision Records (ADRs)
An Architectural Decision (AD) is a justified software design choice that addresses a functional or non-functional requirement of architectural significance. This decision is documented in an Architectural Decision Record (ADR), which details a single AD and its underlying rationale. This section contains a list of all ADRs in Saluki.
Adding new ADRs
Adding a new ADR is a straightforward process:
- Create a new file in the
docs/reference/adrs/recordsdirectory with a name following the patternnumber-title.md. Thenumbershould be the next highest number in the sequence based on the existing ADRs.titleshould be a very short description of the decision, such as related acronyms or keywords related to the decision. - Write the ADR content in Markdown format, following the template provided in the
docs/reference/adrs/_template.mdfile.