Skip to content
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

organize ADR directory like tendermint's #2693

Merged
merged 2 commits into from
Nov 5, 2018
Merged

organize ADR directory like tendermint's #2693

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66b64b9
organize ADR directory like tendermint
zramsay Nov 5, 2018
c412bcb
better adr template
zramsay Nov 5, 2018
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
4 changes: 2 additions & 2 deletions docs/architecture/decision-records/README.md → docs/architecture/README.md
View file
Open in desktop
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
0 ...cision-records/adr-001-message-counter.md → docs/architecture/adr-001-message-counter.md
View file
Open in desktop
File renamed without changes.
19 changes: 19 additions & 0 deletions docs/architecture/adr-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ADR 000: Template for an ADR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel the old version of this file is better no? Same architecture with more comments

Copy link
Contributor

@alexanderbez alexanderbez Nov 5, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have to agree here (not biased as I wrote it :-p)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll switch it back and sync the other way with tendermint


Author:

## Changelog

## Context

## Decision

## Status

## Consequences

### Positive

### Negative

### Neutral
32 changes: 0 additions & 32 deletions docs/architecture/decision-records/adr-template.md
View file
Open in desktop

This file was deleted.