Skip to content
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

Copy ADR template from Tendermint #2333

Merged
merged 2 commits into from
Sep 14, 2018
Merged

Copy ADR template from Tendermint #2333

merged 2 commits into from
Sep 14, 2018

Conversation

ValarDragon
Copy link
Contributor

I believe we've been discussing adding these templates for awhile. I think its more amenable for longer proposals than github issues (as it allows threads of conversation), and was also desired in #1192


For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ValarDragon -- I also had this started when I worked on the signed message ICS, so I left a comment on the template 👍

@@ -0,0 +1,15 @@
# ADR 000: Template for an ADR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think the template I had here would be more helpful/descriptive?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh cool didn't see that! Yeah that template looks way better, I'll copy it here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@codecov
Copy link

codecov bot commented Sep 13, 2018

Codecov Report

Merging #2333 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #2333   +/-   ##
========================================
  Coverage    65.04%   65.04%           
========================================
  Files          135      135           
  Lines         8399     8399           
========================================
  Hits          5463     5463           
  Misses        2574     2574           
  Partials       362      362

@ValarDragon
Copy link
Contributor Author

ValarDragon commented Sep 13, 2018

I modified @alexanderbez ADR Template. I modified the descriptors a fair amount though , from my understanding with the Tendermint ADR's. Feel free to comment if anyone would like any of the section descriptors to be changed / the current state is sub-ideal.

@rigelrozanski rigelrozanski merged commit b5f8350 into develop Sep 14, 2018
@cwgoes cwgoes deleted the dev/ADR_template branch September 14, 2018 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants