Skip to content

Commit

Permalink
Merge pull request hashgraph#9 from Cooper-Kunz/master
Browse files Browse the repository at this point in the history
WIP: HIP Template
  • Loading branch information
Cooper-Kunz authored Nov 14, 2019
2 parents 2d5cd3c + 94534e8 commit 522fbab
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 3 deletions.
61 changes: 61 additions & 0 deletions HIP/0000-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
Title: <HIP title>
Authors: <John Doe ([email protected]), @githubuser29>
Status: <Work in Progress, Draft, Last Call, Accepted by the community, Proposed to the HGC, Accepted by the HGC, Final, Deferred, Rejected, Superseded>
Type: <Standard Track | HRC | Informational | Process>
Category (*only required for Standard Track): <Core | Interface | Economics>
Created: <date created on, in (yyyy-mm-dd) format>
Updated: <any dates this has been altered, in (yyyy-mm-dd) format>
Requires (*optional): <HIP number(s) or title(s)>
Replaces (*optional): <HIP number(s) or title(s)>
---

Hedera Improvement Proposal (HIP) Template

## Summary
Please provide a simple summary of your improvement proposal.

## Motivation
Please elaborate in a few sentences why this would be an improvement to the existing ecosystem of Hedera software.

This could be a problem it solves, a use case being developed that could benefit, etc.

## Goals

Please provide a bulleted list of goals you'd like this to accomplish.

* Enable more individuals to get involved with Hedera.
* Standards can be more easily created, benefitting the entire community.

## Non-goals

Please provide a bulleted list of items you're not trying to achieve.

* Debate or discuss other projects.

## Specification
The technical specification should describe the syntax and semantics of any new feature.

This is the opportunity to let the community know how you think it should be implemented.

Please include images, graphics, or resources that may help visualize the specification, e.g. UML diagrams, flowcharts, etc. These should be named with the same prefix as the proposal, and checked into the same directory.

## Backwards Compatibility
HIPs that do, or could potentially introduce backwards incompatibilities must include a section outlining potential issues.

The HIP must explain how the author proposes to deal with these incompatibilities.

HIP submissions without a sufficient backwards compatibility treatise may be rejected outright.

## Scope and Impact
Please outline all affected properties, whether clients, SDKs, or tools, that would be impacted by this change.

## Test Cases
Where makes sense, please provide outlined test cases or example test cases that would exhibit desired behavior.

## Implementation
What is the implementation plan for this issue?

Do you already have a solution planned and waiting to be accepted? Show us here!

Does it require Hedera support, or potential funding? Let the community know.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The goal of HIPs is to have a place to propose new features, to collect communit

## Types

There are two types of Hedera Improvement Proposals:
There are four types of Hedera Improvement Proposals:

- A Standard HIP - describes any changes that affect most or all clients using or running Hedera Hashgraph, this can be a change to the network protocol, transaction validity rules, proposed application standards/conventions, or any changes or addition that affects the interoperability of applications using Hedera Hashgraph. Standard HIPs can be broken down into the following categories:

Expand All @@ -24,10 +24,12 @@ There are two types of Hedera Improvement Proposals:

- Economics: This type of proposal includes improvements to the Hedera fee structure, token distribution, proof-of-stake, and other areas relating to the economics of Hedera.

- HRC: This type of proposal is a Hedera “request for comment” - HIPs under this distinction require elaboration or commentary from the core Hedera team before recategorizing or moving forward with the proposal.
- An HRC - This type of proposal is a Hedera “request for comment” - HIPs under this distinction require elaboration or commentary from the core Hedera team before recategorizing or moving forward with the proposal.

- An Informational HIP - This type of proposal provides general guidelines or information to the Hedera Hashgraph community, but does not propose a new feature. Informational HIPs do not necessarily represent Hedera Hashgraph community consensus or recommendation, and so users are free to ignore Informational HIPs.

- A Process HIP - This type of proposal includes any changes that affect the Hedera development process. Process HIPs are similar to Standard HIPs but modify tools and software beyond just the core Hedera Hashgraph protocol. Proposals of this category are typically more than simple recommendations, often requiring users to pay attention and make subsequent changes to additional software. Because of the impact in the Hedera development process, these proposals often require a community-based consensus. Examples include but are not limited to: developer guidelines, changes to an existing decision-making process, and changes to the tools or environment used in Hedera development.

## Qualifications

Each HIP should only be one single key proposal and/or idea. The idea should be focused and only issue to one subject matter to be successful. A HIP must meet certain minimum criteria: it must be clear and have a complete description of the proposed enhancement, the enhancement must represent a net improvement, the proposed implementation, if applicable, must be solid and must not complicate the protocol unduly.
Expand Down Expand Up @@ -61,6 +63,8 @@ Parties involved in this process are often, but not always, you (the HIP author)

4. Accepted by the community

> Note: steps 5 & 6 only apply to Standard HIPs requiring core protocol changes, and therefore Governing Council approval.
5. Proposed to the HGC

6. Accepted by the HGC
Expand All @@ -81,4 +85,4 @@ The status change of each HIP is requested by the HIP author and it is to be rev

These improvement proposals are intended to be the community voice for changes, but the implementation of Hedera Hashgraph is left to the engineers working at Hedera, and decisions regarding the platform and codebase strategy or future roadmap are ultimately made by the Hedera Governing Council. At some point, Hedera may have their own improvement made separately from this community managed repository, and may make changes not outlined in an HIP.

These proposals and discussions have no effect regarding private (permissioned) implementations of the Hashgraph consensus algorithm; additionally, this repository and it’s contents are ran by the Hedera Hashgraph community, which means they do not necessarily reflect the views and opinions of Hedera Hashgraph LLC.
These proposals and discussions have no effect regarding private (permissioned) implementations of the Hashgraph consensus algorithm; additionally, this repository and it’s contents are run by the Hedera Hashgraph community, which means they do not necessarily reflect the views and opinions of Hedera Hashgraph LLC.

0 comments on commit 522fbab

Please sign in to comment.