Skip to content

Commit

Permalink
Merge pull request #2693 from cosmos/fix-adr-structure
Browse files Browse the repository at this point in the history
organize ADR directory like tendermint's
  • Loading branch information
zramsay authored Nov 5, 2018
2 parents 10e8e03 + c412bcb commit 300b74a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Architecture Decision Records (ADR)

This is a location to record all high-level architecture decisions in the cosmos-sdk project.
This is a location to record all high-level architecture decisions in the Cosmos SDK project.

You can read more about the ADR concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t).
You can read more about the ADR concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t). See the [tendermint ADRs](https://github.com/tendermint/tendermint/tree/master/docs/architecture) for examples.

An ADR should provide:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,23 @@
* {date}: {changelog}

## Context
> This section contains all the context one needs to understand the current state, and why there is a problem. It should be as succinct as possible and introduce the high level idea behind the solution.

> This section contains all the context one needs to understand the current state, and why there is a problem. It should be as succinct as possible and introduce the high level idea behind the solution.
## Decision

> This section explains all of the details of the proposed solution, including implementation details.
It should also describe affects / corollary items that may need to be changed as a part of this.
If the proposed change will be large, please also indicate a way to do the change to maximize ease of review.
(e.g. the optimal split of things to do between separate PR's)

## Status

> A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later ADR changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement.
{Deprecated|Proposed|Accepted}

## Consequences

> This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the "positive" ones.
### Positive
Expand All @@ -27,6 +30,7 @@ If the proposed change will be large, please also indicate a way to do the chang
### Neutral

## References

> Are there any relevant PR comments, issues that led up to this, or articles referrenced for why we made the given design choice? If so link them here!
* {reference link}

0 comments on commit 300b74a

Please sign in to comment.