Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-04-21 13:37:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 91
fleet/docs/Contributing/adr/template.md

1.3 KiB
Raw Blame History

ADR-NNNN: Title

Status

Proposed | Accepted | Rejected | Deprecated | Superseded

If superseded, include a link to the new ADR: ADR-NNNN: New ADR Title

Date

YYYY-MM-DD

Context

Describe the context and problem statement. What is the issue that we're seeing that is motivating this decision or change?

Include any constraints that influenced the decision (technical, business, or otherwise).

Decision

Describe the decision that was made. State the decision in full sentences, with active voice.

Explain the solution chosen and why it was selected over alternatives.

Consequences

Describe the consequences of the decision, both positive and negative. This should include:

  • Benefits of implementing this decision
  • Drawbacks or technical debt incurred
  • Impact on existing systems or processes
  • Future considerations or follow-up decisions needed

Alternatives considered

Describe alternative solutions that were considered and why they were not chosen.

For each alternative:

  • Describe the alternative approach
  • List pros and cons
  • Explain why it was not selected

References

List any references, such as:

  • Links to related issues or discussions
  • External articles or documentation
  • Research or data that influenced the decision