mirror of
https://github.com/fleetdm/fleet
synced 2026-05-23 00:49:03 +00:00
a31db7fc83
See doc. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a new decision record outlining the reasons for not using GitHub Discussions for technical conversations and summarizing considered alternatives. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Luke Heath <luke@fleetdm.com> |
||
|---|---|---|
| .. | ||
| 0001-pilot-service-layer-packages.md | ||
| 0002-github-discussions.md | ||
| README.md | ||
| template.md | ||
Architectural Decision Records (ADRs)
This directory contains Architectural Decision Records (ADRs) for Fleet.
What are ADRs?
Architectural Decision Records (ADRs) are documents that capture important architectural decisions made along with their context and consequences. They provide a record of architectural decisions that affect the system, the context in which they were made, and the rationale behind them.
Why use ADRs?
ADRs help teams:
- Document important decisions for future reference
- Communicate the reasoning behind decisions
- Onboard new team members by providing context
- Track the evolution of the system architecture over time
ADR format
Each ADR follows a standard format:
- Title: A descriptive title that summarizes the decision
- Status: Proposed, Accepted, Rejected, Deprecated, or Superseded
- Context: The context and problem statement that led to this decision
- Decision: The decision that was made
- Consequences: The consequences of the decision, both positive and negative
- References: Any references to related documents or resources
Creating a new ADR
To create a new ADR:
- Copy the template to a new file named
NNNN-descriptive-title.mdwhereNNNNis the next number in sequence - Fill in the template with your decision
- Submit a pull request with your new ADR