Skip to content

docs: introduce ADRs #1505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 30, 2022
Merged

docs: introduce ADRs #1505

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a787761
docs: introduce ADRs
csviri Sep 30, 2022
700c88a
remove unrelated change
csviri Sep 30, 2022
c332e01
ignore adr only changes for build
csviri Sep 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions adr/001-Introducing-ADRs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Using Architectural Decision Records

In order to into to document and facilitate discussion over architecture and other design question of the project
we introduce usage of [ADR](https://adr.github.io/).

In each ADR file, write these sections:

# Title

## Status

What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.?

## Context

What is the issue that we're seeing that is motivating this decision or change?

## Decision

What is the change that we're proposing and/or doing?

## Consequences

What becomes easier or more difficult to do because of this change?

## Notes

Other notes optionally added to the ADR.
Soo other good materials for the ADRs: