From 6f614119e85ea521092f22b88a44dfe2b46b8dc0 Mon Sep 17 00:00:00 2001 From: Anton Kaliaev Date: Mon, 27 Jul 2020 21:36:05 +0400 Subject: [PATCH] docs: simplify choosing an ADR number (#5156) Closes #2313 --- CONTRIBUTING.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25efabbd8..e41d2b77d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,14 +30,17 @@ Comment](https://github.com/tendermint/spec/tree/master/rfc). Discussion at the RFC stage will build collective understanding of the dimensions of the problems and help structure conversations around trade-offs. -When the problem is well understood but the solution leads to large -structural changes to the code base, these changes should be proposed in -the form of an [Architectural Decision Record -(ADR)](./docs/architecture/). The ADR will help build consensus on an -overall strategy to ensure the code base maintains coherence -in the larger context. If you are not comfortable with writing an ADR, -you can open a less-formal issue and the maintainers will help you -turn it into an ADR. ADR numbers can be registered [here](https://github.com/tendermint/tendermint/issues/2313). +When the problem is well understood but the solution leads to large structural +changes to the code base, these changes should be proposed in the form of an +[Architectural Decision Record (ADR)](./docs/architecture/). The ADR will help +build consensus on an overall strategy to ensure the code base maintains +coherence in the larger context. If you are not comfortable with writing an +ADR, you can open a less-formal issue and the maintainers will help you turn it +into an ADR. + +> How to pick a number for the ADR? + +Find the largest existing ADR number and bump it by 1. When the problem as well as proposed solution are well understood, changes should start with a [draft