-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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.
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
docs: add adr/rfc section to contributing #15385
Conversation
Based on this flow chat I think the ValidateBasic RFC might actually be an ADR... Are there existing processes in other projects we can reference? |
This diagram was used in tendermint so i copied it over. I can modify it to be more towards capturing conversations and documenting them the reason i think its more of a RFC is because how its removed is a bit more unclear, in the sdk for now we are making them a noop but in the future it would be remove entirely. |
A few links I came across: Based on this we have been using ADRs as RFCs. I think a more simple flow chart would be:
ADR means decision record so really we shouldn't be requesting any comments at that stage really, right? |
this makes sense to me. I think we should still get comments on adrs but not as much as an rfc or ADR currently. Ill adjust |
Yeah maybe we can think of an ADR review as a last call for comments space. Any ADR that has evolved into a longer discussion should have been an RFC |
Although our ADR process is currently like an RFC process: https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/PROCESS.md. We should probably split a good part of this out to RFCs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
generally looks good
aaron's comment here makes more sense
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should remove or update the image since it no longer reflects this process
docs/rfc/PROCESS.md
Outdated
|
||
5. Merged RFCs SHOULD NOT be pruned. | ||
|
||
6. If there is consensus and enough feedback, an ADR can be written on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should maybe say about more about when and how RFCs turn into ADRs (or not). Does an RFC stop being an RFC and become an ADR once there's consensus? Or does it remain an RFC and there's a separate ADR? Or is it just an RFC with status accepted and no ADR?
Co-authored-by: Aaron Craelius <aaron@regen.network>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nits
Co-authored-by: Likhita Polavarapu <78951027+likhita-809@users.noreply.github.com>
Description
This pr adds a section to contributing on when to write an ADR or an RFC. Would love feedback on if this makes sense.
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...
!
to the type prefix if API or client breaking changeCHANGELOG.md
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...
!
in the type prefix if API or client breaking change