docs: update adr section of contributing #9710
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tac0turtle
reviewed
Jul 26, 2021
CONTRIBUTING.md
Outdated
| so further discussions can be made. We are following this process so all involved parties are in | ||
| agreement before any party begins coding the proposed implementation. If you would like to see some examples | ||
| of how these are written refer to the current [ADRs](https://github.com/cosmos/cosmos-sdk/tree/master/docs/architecture). | ||
| When proposing an architecture decision for the SDK, please start by opening an [issue](https://github.com/cosmos/cosmos-sdk/issues/new/choose) or a [discussion](https://github.com/cosmos/cosmos-sdk/discussions/new) with a summary of the proposal. Once the proposal has been discussed and there is an agreed upon design, the [ADR creation process](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/PROCESS.md) can begin. We are following this process to ensure all involved parties are in agreement before any party begins coding the proposed implementation. If you would like to see examples of how these are written, please refer to the current [ADRs](https://github.com/cosmos/cosmos-sdk/tree/master/docs/architecture). |
There was a problem hiding this comment.
nit: Many times the design process will happen in the ADR. We should not limit designs to pre ADR phase.
tac0turtle
approved these changes
Jul 26, 2021
|
Visit https://dashboard.github.orijtech.com?pr=9710&repo=cosmos%2Fcosmos-sdk to see benchmark details. |
clevinson
reviewed
Jul 27, 2021
Co-authored-by: Cory <cjlevinson@gmail.com>
ryanchristo
added
the
A:automerge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
ref #9708
This pull request updates the ADR section of the contributing documentation to clarify that an issue or discussion should be opened (a proposal should be created) before submitting a pull request with the initial draft of the decision record.
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...
docs:prefix in the PR titleReviewers 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...
docs:prefix in the PR title