Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 2.76 KB

0000-template.md

File metadata and controls

97 lines (61 loc) · 2.76 KB
Raw

HIP Template

  • Author(s):
  • Start Date:
  • Category:
  • Original HIP PR:
  • Tracking Issue:

Summary

One paragraph explanation of the proposal.

Motivation

Why are we doing this? What use cases does it support? What problems does it solve? What is the expected outcome?

Stakeholders

  • Who is affected by this HIP?

  • How are we soliciting feedback on this HIP from these stakeholders? Note that they may not be watching the HIPs repository or even aren't directly active in the Helium Community Slack channels.

Detailed Explanation

  • Introduce and explain new concepts.

  • It should be reasonably clear how the proposal would be implemented.

  • Provide representative examples that show how this proposal would be commonly used.

  • Corner cases should be dissected by example.

Drawbacks

  • Why should we not do this?

Rationale and Alternatives

This is your chance to discuss your proposal in the context of the whole design space. This is probably the most important section!

  • Why is this design the best in the space of possible designs?

  • What other designs have been considered and what is the rationale for not choosing them?

  • What is the impact of not doing this?

Unresolved Questions

  • What parts of the design do you expect to resolve through the HIP process before this gets merged?

  • What parts of the design do you expect to resolve through the implementation of this feature?

  • What related issues do you consider out of scope for this HIP that could be addressed in the future independently of the solution that comes out of this HIP?

Deployment Impact

Describe how this design will be deployed and any potential impact it may have on current users of this project.

  • How will current users be impacted?

  • How will existing documentation/knowlegebase need to be supported?

  • Is this backwards compatible?

      - If not, what is the procedure to migrate?

Success Metrics

What metrics can be used to measure the success of this design?

  • What should we measure to prove a performance increase?

  • What should we measure to prove an improvement in stability?

  • What should we measure to prove a reduction in complexity?

  • What should we measure to prove an acceptance of this by it's users?