omissis/go-jsonschema

View on GitHub
docs/arch/0001-record-architecture-decisions.md

Summary

Maintainability
Test Coverage
# 1. Record architecture decisions

Date: 2023-04-09

## Status

Accepted

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as [described by Michael Nygard][documenting-architecture-decisions].
There is a good summary of available resources at [https://adr.github.io][github-adr].

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools][adr-tools].

[adr-tools]: https://github.com/npryce/adr-tools
[documenting-architecture-decisions]: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
[github-adr]: https://adr.github.io