Adopt Architecture Decision Records

This commit is contained in:
Wilson Silva 2024-03-13 12:46:48 +00:00
parent 5497930dd5
commit 17cd2bf0f4
No known key found for this signature in database
GPG Key ID: 65135F94E23F82C8
3 changed files with 24 additions and 0 deletions

1
.adr-dir Normal file
View File

@ -0,0 +1 @@
adr

View File

@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [Unreleased]
### Added
- Added Architecture Decision Records (ADRs) to document architectural decisions
### Fixed
- Fixed YARD example rendering issues in `InvalidKeyFormatError#initialize`, `InvalidKeyLengthError#initialize`,

View File

@ -0,0 +1,19 @@
# 1. Record architecture decisions
Date: 2024-03-13
## 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](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
## Consequences
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).