Back to Hertzbeat

HIP-XXX: Proposal title

hip/TEMPLATE.md

1.8.03.7 KB
Original Source
<!-- RULES * Never place a link to an external site like Google Doc. The proposal should be in this issue entirely. * Use a spelling and grammar checker tools if available for you (there are plenty of free ones). PROPOSAL HEALTH CHECK I can read the design document and understand the problem statement and what you plan to change *without* resorting to a couple of hours of code reading just to start having a high level understanding of the change. IMAGES If you need diagrams, avoid attaching large files. You can use [MermaidJS]([url](https://mermaid.js.org/)) as a simple language to describe many types of diagrams. THIS COMMENTS Please remove them when done. -->

HIP-XXX: Proposal title

Background knowledge

<!-- Describes all the knowledge you need to know in order to understand all the other sections in this HIP * Give a high level explanation on all concepts you will be using throughout this document. For example, if you want to talk about New Monitor Protocol, explain briefly (1 paragraph) what this is. If you're going to change something specific, then go into more detail about it and how it works. * Provide links where possible if a person wants to dig deeper into the background information. DON'T * Do not include links *instead* explanation. Do provide links for further explanation. -->

Motivation

<!-- Describe the problem this proposal is trying to solve. * Explain what is the problem you're trying to solve - current situation. * This section is the "Why" of your proposal. -->

Goals

In Scope

<!-- What this HIP intend to achieve once It's integrated into HertzBeat. Why does it benefit HertzBeat? -->

High Level Design

<!-- Describe the design of your solution in *high level*. Describe the solution end to end, from a birds-eye view. Don't go into implementation details in this section. I should be able to finish reading from beginning of the HIP to here (including) and understand the feature and how you intend to solve it, end to end. DON'T * Avoid code snippets, unless it's essential to explain your intent. -->

Detailed Design

Design & Implementation Details

<!-- This is the section where you dive into the details. It can be: * Concrete class names and their roles and responsibility, including methods. * Code snippets of existing code. * Interface names and its methods. * ... -->

Public-facing Changes

<!-- (Optional) Describe the additions you plan to make for each public facing component. Remove the sections you are not changing. Clearly mark any changes which are BREAKING backward compatability. -->

Binary protocol

<!-- (Optional) -->

Configuration

<!-- (Optional) -->

CLI

<!-- (Optional) -->

Security Considerations

<!-- (Optional) A detailed description of the security details that ought to be considered for the HIP. This is most relevant for any new HTTP endpoints, new HertzBeat Protocol Commands, and new security features. The goal is to describe details like which role will have permission to perform an action. -->

Backward & Forward Compatibility

<!-- (Optional) -->

Revert

<!-- Describe a cookbook detailing the steps required to revert HertzBeat to previous version *without* this feature. -->

Upgrade

<!-- Specify the list of instructions, if there are such, needed to perform before/after upgrading to HertzBeat version containing this feature. -->

Alternatives

<!-- (Optional) If there are alternatives that were already considered by the authors or, after the discussion, by the community, and were rejected, please list them here along with the reason why they were rejected. -->

General Notes

<!-- (Optional) -->

Links

<!-- Updated afterwards -->
  • Mailing List discussion thread:
  • Mailing List voting thread: