856cc5b096
## Description Recently when discussing NFT standard we stumbled upon the proper use of keywards such as SHOULD, MAY etc ... Let's add them to our guidelines. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct `docs:` prefix in the PR title - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md) - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [x] confirmed the correct `docs:` prefix in the PR title - [ ] confirmed all author checklist items have been addressed - [x] confirmed that this PR only changes documentation - [x] reviewed content for consistency - [x] reviewed content for thoroughness - [x] reviewed content for spelling and grammar - [ ] tested instructions (if applicable) |
||
|---|---|---|
| .. | ||
| PROCESS.md | ||
| README.md | ||
| adr-002-docs-structure.md | ||
| adr-003-dynamic-capability-store.md | ||
| adr-004-split-denomination-keys.md | ||
| adr-006-secret-store-replacement.md | ||
| adr-007-specialization-groups.md | ||
| adr-008-dCERT-group.md | ||
| adr-009-evidence-module.md | ||
| adr-010-modular-antehandler.md | ||
| adr-011-generalize-genesis-accounts.md | ||
| adr-012-state-accessors.md | ||
| adr-013-metrics.md | ||
| adr-014-proportional-slashing.md | ||
| adr-016-validator-consensus-key-rotation.md | ||
| adr-017-historical-header-module.md | ||
| adr-018-extendable-voting-period.md | ||
| adr-019-protobuf-state-encoding.md | ||
| adr-020-protobuf-transaction-encoding.md | ||
| adr-021-protobuf-query-encoding.md | ||
| adr-022-custom-panic-handling.md | ||
| adr-023-protobuf-naming.md | ||
| adr-024-coin-metadata.md | ||
| adr-027-deterministic-protobuf-serialization.md | ||
| adr-028-public-key-addresses.md | ||
| adr-029-fee-grant-module.md | ||
| adr-030-authz-module.md | ||
| adr-031-msg-service.md | ||
| adr-032-typed-events.md | ||
| adr-033-protobuf-inter-module-comm.md | ||
| adr-034-account-rekeying.md | ||
| adr-035-rosetta-api-support.md | ||
| adr-036-arbitrary-signature.md | ||
| adr-037-gov-split-vote.md | ||
| adr-038-state-listening.md | ||
| adr-039-epoched-staking.md | ||
| adr-040-storage-and-smt-state-commitments.md | ||
| adr-041-in-place-store-migrations.md | ||
| adr-042-group-module.md | ||
| adr-template.md | ||
README.md
| order | parent | ||
|---|---|---|---|
| false |
|
Architecture Decision Records (ADR)
This is a location to record all high-level architecture decisions in the Cosmos-SDK.
An Architectural Decision (AD) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant. An Architecturally Significant Requirement (ASR) is a requirement that has a measurable effect on a software system’s architecture and quality. An Architectural Decision Record (ADR) captures a single AD, such as often done when writing personal notes or meeting minutes; the collection of ADRs created and maintained in a project constitute its decision log. All these are within the topic of Architectural Knowledge Management (AKM).
You can read more about the ADR concept in this blog post.
Rationale
ADRs are intended to be the primary mechanism for proposing new feature designs and new processes, for collecting community input on an issue, and for documenting the design decisions. 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.
Creating new ADR
Read about the PROCESS.
Use RFC 2119 Keywords
When writing ADRs, follow the same best practices for writing RFCs. When writing RFCs, key words are used to signify the requirements in the specification. These words are often capitalized: "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL. They are to be interpreted as described in RFC 2119.
ADR Table of Contents
Accepted
- ADR 002: SDK Documentation Structure
- ADR 004: Split Denomination Keys
- ADR 006: Secret Store Replacement
- ADR 009: Evidence Module
- ADR 010: Modular AnteHandler
- ADR 019: Protocol Buffer State Encoding
- ADR 020: Protocol Buffer Transaction Encoding
- ADR 021: Protocol Buffer Query Encoding
- ADR 023: Protocol Buffer Naming and Versioning
- ADR 029: Fee Grant Module
- ADR 030: Message Authorization Module
- ADR 031: Protobuf Msg Services
Proposed
- ADR 003: Dynamic Capability Store
- ADR 011: Generalize Genesis Accounts
- ADR 012: State Accessors
- ADR 013: Metrics
- ADR 016: Validator Consensus Key Rotation
- ADR 017: Historical Header Module
- ADR 018: Extendable Voting Periods
- ADR 022: Custom baseapp panic handling
- ADR 024: Coin Metadata
- ADR 027: Deterministic Protobuf Serialization
- ADR 028: Public Key Addresses
- ADR 032: Typed Events
- ADR 033: Inter-module RPC
- ADR 035: Rosetta API Support
- ADR 037: Governance Split Votes
- ADR 038: State Listening
- ADR 039: Epoched Staking
- ADR 040: Storage and SMT State Commitments