7bc705af85
- Added a ADR section to the Contributing.md - This will streamline and create a central palce for discussions - Currently conversations are fragmented across platfroms and different forum posts, the aim here is to move it all to one place and create a document to be used as reference in the future for why SDK went in this direction. |
||
|---|---|---|
| .. | ||
| adr-template.md | ||
| README.md | ||
Architecture Decision Records (ADR)
This is a location to record all high-level architecture decisions in the Cosmos-SDK.
You can read more about the ADR concept in this blog post.
An ADR should provide:
- Context on the relevant goals and the current state
- Proposed changes to achieve the goals
- Summary of pros and cons
- References
- Changelog
Note the distinction between an ADR and a spec. The ADR provides the context, intuition, reasoning, and justification for a change in architecture, or for the architecture of something new. The spec is much more compressed and streamlined summary of everything as it stands today.
If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.
Note the context/background should be written in the present tense.