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

GIP-0061: Improvements to the GIP process (WIP) #30

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Binary file modified assets/gip-0001/gip-process-flowchart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 5 additions & 6 deletions gips/0000-template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
GIP: <The number of this GIP. To be assigned by editors.>
GIP: <The number of this GIP. Selected by the author and confirmed by editors (which may change numbers to resolve conflicts)>
Title: <The title of this GIP>
Authors: <A list of authors. Include full name or pseudonym. At least one author must have valid contact information provided in angle brackets.>
Created: <The date the GIP was created.>
Updated: <The date the GIP was last updated.>
Stage: <The current stage of the proposal. Specified by the author and confirmed by editors by virtue of a GIP being accepted into an editor's view of the repo.>
Stage: <The current stage of the proposal. Specified by the author and confirmed by editors by virtue of a GIP being accepted into the main branch of the GitHub repo. See GIP-0001 for the possible stages and process.>
Discussions-To: <The forum post where this proposal is discussed.>
Category: <(Optional) The type of GIP or GRP. This field should be left blank for GRCs. Valid types are "Protocol Logic," "Protocol Interfaces," "Subgraph API," "Process," "Economic Parameters," and "Protocol Charters".>
Copy link
Collaborator

Choose a reason for hiding this comment

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

This line refers to GRP which I believe will be removed going forward. Should this reference be removed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point

Depends-On: <(Optional) A list of GIPs that this GIP depends on. If some other type of dependency exists, include a reference link here and an explanation in the body of the GIP.>
Expand All @@ -20,7 +19,7 @@ Audits: <(Optional) A list of URLs to audits related to this proposal.>

*This is a template GIP proposal showing the layout and formatting described in GIP 0001. Italicized writing are comments and should be removed or replaced. Sections marked optional may also be removed if left empty.*

*All GIPs MUST include a preamble, in RFC 822 format, preceded and followed by three dashes ("-"). This formatting aids in compatibility with most static site generators.*
*All GIPs MUST include a preamble, in RFC 822 format, preceded and followed by three dashes ("---"). This formatting aids in compatibility with most static site generators.*

*Given the heterogeneous types of proposals this template is meant to reflect, most sections below, except "Abstract" and "Motivation," may be treated as optional. The author, however, should exercise good judgment in deviating from the template, as they are reflective of the type of information, when relevant, that editors will look for in reviewing a proposal.*

Expand All @@ -38,11 +37,11 @@ Audits: <(Optional) A list of URLs to audits related to this proposal.>

# High-Level Description

*(Optional) Describe your specific solution at a high level. Include diagrams, math formulas, pseudocode, and any other artifacts helpful in showing how your proposal works at a conceptual level. This type of information is required for a proposal to reach the "Proposal" stage.*
*(Optional) Describe your specific solution at a high level. Include diagrams, math formulas, pseudocode, and any other artifacts helpful in showing how your proposal works at a conceptual level.

# Detailed Specification

*(Optional) Include specific APIs, semantics, data structures, code snippets, etc. related to this proposal. This type of info is required for a proposal to reach the "Draft" stage.*
*(Optional) Include specific APIs, semantics, data structures, code snippets, etc. related to this proposal.

# Backward Compatibility

Expand Down
Loading