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

Create a 'disclosure' log #82

Closed
4 tasks done
adizere opened this issue Jun 2, 2020 · 3 comments · Fixed by #83
Closed
4 tasks done

Create a 'disclosure' log #82

adizere opened this issue Jun 2, 2020 · 3 comments · Fixed by #83
Assignees
Labels
I: documentation Internal: improvements or additions to documentation I: spec Internal: related to IBC specifications
Milestone

Comments

@adizere
Copy link
Member

adizere commented Jun 2, 2020

Summary

Create a document to record all bugs/issues we uncover while specifying & formally verifying the IBC protocols.

Problem Definition

This feature addresses the problem of keeping a historical log of contentious matters in the IBC specs. We can share this log with external collaborators and disclose any issue we find in a transparent manner.

It is unclear if a markdown file is the right format to record these matters. Main disadvantage is that this document might be difficult to maintain over time.

Proposal

  • A basic markdown file docs/disclosure-log.md will help us keep track and disclose all the problems we find.
  • Each entry in this file will consist of a brief description + a commit hash. The hash will usually point to the full details of that problem.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@adizere adizere added I: documentation Internal: improvements or additions to documentation I: spec Internal: related to IBC specifications ibc-ics labels Jun 2, 2020
@adizere adizere self-assigned this Jun 2, 2020
@cwgoes
Copy link

cwgoes commented Jun 2, 2020

Thanks, this would be helpful. I'm open to any sort of process changes in the specification repository or procedures which you think would make this easier.

@ebuchman
Copy link
Member

ebuchman commented Jul 1, 2020

Why not just open issues in cosmos/ics?

@adizere
Copy link
Member Author

adizere commented Jul 2, 2020

We are opening issues in the other repo in addition to this disclosure log. The point of the log was to have a single place with the history of all issues we discussed so we can easily report/refer to them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: documentation Internal: improvements or additions to documentation I: spec Internal: related to IBC specifications
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants