Permalink
Browse files

gip-1

  • Loading branch information...
owocki committed Mar 13, 2018
1 parent f81f569 commit 213c705ede6bd577bfaf85305f74dcb82087ebf0
Showing with 28 additions and 28 deletions.
  1. +23 −25 GIPS/gip-1.md
  2. +4 −2 README.md
  3. +1 −1 gip-X.md
@@ -2,51 +2,51 @@
Title: GIP Purpose and Guidelines
Status: Active
Type: Meta
Author: Martin Becze <mb@ethereum.org>, Hudson Jameson <hudson@ethereum.org>
Created: 2015-10-27, 2017-02-01
Author: Martin Becze <mb@Ethereum.org>, Hudson Jameson <hudson@Ethereum.org> (EIPs). Kevin Owocki (kevin@gitcoin.co) (GIPS)
Created: 2015-10-27, 2017-02-01 (EIPs) 2019-03-12 (GIPs)
What is an GIP?
--------------
GIP stands for Ethereum Improvement Proposal. An GIP is a design document providing information to the Ethereum community, or describing a new feature for Ethereum or its processes or environment. The GIP should provide a concise technical specification of the feature and a rationale for the feature. The GIP author is responsible for building consensus within the community and documenting dissenting opinions.
GIP stands for Gitcoin Improvement Proposal. An GIP is a design document providing information to the Gitcoin community, or describing a new feature for Gitcoin or its processes or environment. The GIP should provide a concise technical specification of the feature and a rationale for the feature. The GIP author is responsible for building consensus within the community and documenting dissenting opinions.
GIP Rational
------------
We intend GIPs to be the primary mechanisms for proposing new features, for collecting community input on an issue, and for documenting the design decisions that have gone into Ethereum. Because the GIPs are maintained as text files in a versioned repository, their revision history is the historical record of the feature proposal.
We intend GIPs to be the primary mechanisms for proposing new features, for collecting community input on an issue, and for documenting the design decisions that have gone into Gitcoin. Because the GIPs are maintained as text files in a versioned repository, their revision history is the historical record of the feature proposal.
For Ethereum implementers, GIPs are a convenient way to track the progress of their implementation. Ideally each implementation maintainer would list the GIPs that they have implemented. This will give end users a convenient way to know the current status of a given implementation or library.
For Gitcoin implementers, GIPs are a convenient way to track the progress of their implementation. Ideally each implementation maintainer would list the GIPs that they have implemented. This will give end users a convenient way to know the current status of a given implementation or library.
GIP Types
---------
There are three types of GIP:
- A **Standard Track GIP** describes any change that affects most or all Ethereum implementations, such as a change to the the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Ethereum. Furthermore Standard GIPs can be broken down into the following categories.
- **Core** - improvements requiring a consensus fork (e.g. [GIP5], [GIP101]), as well as changes that are not necessarily consensus critical but may be relevant to “core dev” discussions (for example, [GIP90], and the miner/node strategy changes 2, 3, and 4 of [GIP86]).
- **Networking** - includes improvements around [devp2p] ([GIP8]) and [Light Ethereum Subprotocol], as well as proposed improvements to network protocol specifications of [whisper] and [swarm].
- **Interface** - includes improvements around client [API/RPC] specifications and standards, and also certain language-level standards like method names ([GIP59], [GIP6]) and [contract ABIs]. The label “interface” aligns with the [interfaces repo] and discussion should primarily occur in that repository before an GIP is submitted to the GIPs repository.
- **ERC** - application-level standards and conventions, including contract standards such as token standards ([ERC20]), name registries ([ERC26], [ERC137]), URI schemes ([ERC67]), library/package formats ([GIP82]), and wallet formats ([GIP75], [GIP85]).
- A **Standard Track GIP** describes any change that affects most or all Gitcoin implementations, such as a change to the the network protocol, a change in block or transaction validity rules, proposed application standards/conventions, or any change or addition that affects the interoperability of applications using Gitcoin. Furthermore Standard GIPs can be broken down into the following categories.
- **Core** - improvements requiring a consensus fork, as well as changes that are not necessarily consensus critical but may be relevant to “core dev” discussions.
- **Application** - includes improvements around and, as well as proposed improvements to application..
- **Interface** - includes improvements around client [API/web] specifications and standards. The label “interface” aligns with the [interfaces repo] and discussion should primarily occur in that repository before an GIP is submitted to the GIPs repository.
- **GRC** - application-level standards and conventions, including contract standards such as token standards, etc..
- An **Informational GIP** describes a Ethereum design issue, or provides general guidelines or information to the Ethereum community, but does not propose a new feature. Informational GIPs do not necessarily represent Ethereum community consensus or a recommendation, so users and implementers are free to ignore Informational GIPs or follow their advice.
- A **Meta GIP** describes a process surrounding Ethereum or proposes a change to (or an event in) a process. Process GIPs are like Standards Track GIPs but apply to areas other than the Ethereum protocol itself. They may propose an implementation, but not to Ethereum's codebase; they often require community consensus; unlike Informational GIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Ethereum development. Any meta-GIP is also considered a Process GIP.
- An **Informational GIP** describes a Gitcoin design issue, or provides general guidelines or information to the Gitcoin community, but does not propose a new feature. Informational GIPs do not necessarily represent Gitcoin community consensus or a recommendation, so users and implementers are free to ignore Informational GIPs or follow their advice.
- A **Meta GIP** describes a process surrounding Gitcoin or proposes a change to (or an event in) a process. Process GIPs are like Standards Track GIPs but apply to areas other than the Gitcoin protocol itself. They may propose an implementation, but not to Gitcoin's codebase; they often require community consensus; unlike Informational GIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in Gitcoin development. Any meta-GIP is also considered a Process GIP.
GIP Work Flow
-------------
The GIP repository Collaborators change the GIPs status. Please send all GIP-related email to the GIP Collaborators, which is listed under GIP Editors below. Also see GIP Editor Responsibilities & Workflow.
The GIP process begins with a new idea for Ethereum. It is highly recommended that a single GIP contain a single key proposal or new idea. The more focused the GIP, the more successful it tends to be. A change to one client doesn't require an GIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. The GIP editor reserves the right to reject GIP proposals if they appear too unfocused or too broad. If in doubt, split your GIP into several well-focused ones.
The GIP process begins with a new idea for Gitcoin. It is highly recommended that a single GIP contain a single key proposal or new idea. The more focused the GIP, the more successful it tends to be. A change to one client doesn't require an GIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. The GIP editor reserves the right to reject GIP proposals if they appear too unfocused or too broad. If in doubt, split your GIP into several well-focused ones.
Each GIP must have a champion - someone who writes the GIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea.
Vetting an idea publicly before going as far as writing an GIP is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used. Examples of appropriate public forums to gauge interest around your GIP include [the Ethereum subreddit], [the Issues section of this repository], and [one of the Ethereum Gitter chat rooms]. In particular, [the Issues section of this repository] is an excellent place to discuss your proposal with the community and start creating more formalized language around your GIP.
Vetting an idea publicly before going as far as writing an GIP is meant to save the potential author time. Asking the Gitcoin community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Gitcoin is used. Examples of appropriate public forums to gauge interest around your GIP include [the Gitcoin Slack], [the Issues section of this repository], and [one of the Gitcoin Gitter chat rooms]. In particular, [the Issues section of this repository] is an excellent place to discuss your proposal with the community and start creating more formalized language around your GIP.
Once the champion has asked the Ethereum community whether an idea has any chance of acceptance a draft GIP should be presented as a [pull request]. This gives the author a chance to continuously edit the draft GIP for proper formatting and quality. This also allows for further public comment and the author of the GIP to address concerns about the proposal.
Once the champion has asked the Gitcoin community whether an idea has any chance of acceptance a draft GIP should be presented as a [pull request]. This gives the author a chance to continuously edit the draft GIP for proper formatting and quality. This also allows for further public comment and the author of the GIP to address concerns about the proposal.
If the GIP collaborators approve, the GIP editor will assign the GIP a number (generally the issue or PR number related to the GIP), label it as Standards Track, Informational, or Meta, give it status “Draft”, and add it to the git repository. The GIP editor will not unreasonably deny an GIP. Reasons for denying GIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the Ethereum philosophy.
If the GIP collaborators approve, the GIP editor will assign the GIP a number (generally the issue or PR number related to the GIP), label it as Standards Track, Informational, or Meta, give it status “Draft”, and add it to the git repository. The GIP editor will not unreasonably deny an GIP. Reasons for denying GIP status include duplication of effort, being technically unsound, not providing proper motivation or addressing backwards compatibility, or not in keeping with the Gitcoin philosophy.
Standards Track GIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. The GIP should be reviewed and accepted before an implementation is begun, unless an implementation will aid people in studying the GIP. Standards Track GIPs must be implemented in at least three viable Ethereum clients before it can be considered Final.
Standards Track GIPs consist of three parts, a design document, implementation, and finally if warranted an update to the [formal specification]. The GIP should be reviewed and accepted before an implementation is begun, unless an implementation will aid people in studying the GIP. Standards Track GIPs must be implemented in at least three viable Gitcoin clients before it can be considered Final.
For an GIP to be accepted it must meet certain minimum criteria. It must be a clear and 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.
@@ -81,11 +81,11 @@ Each GIP should have the following parts:
<!-- -->
- Motivation (*optional) - The motivation is critical for GIPs that want to change the Ethereum protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the GIP solves. GIP submissions without sufficient motivation may be rejected outright.
- Motivation (*optional) - The motivation is critical for GIPs that want to change the Gitcoin protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the GIP solves. GIP submissions without sufficient motivation may be rejected outright.
<!-- -->
- Specification - The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Ethereum platforms (cpp-ethereum, go-ethereum, parity, ethereumJ, ethereumjs-lib, …).
- Specification - The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current Gitcoin platforms (cpp-Gitcoin, go-Gitcoin, parity, GitcoinJ, Gitcoinjs-lib, …).
<!-- -->
@@ -123,11 +123,11 @@ Each GIP must begin with an RFC 822 style header preamble. The headers must appe
` Author: `<list of author's real names and optionally, email address>
` * Discussions-To: ` <email address>
` * Discussions-To: ` <email address> or slack channel
` Status: `<Draft | Active | Accepted | Deferred | Rejected | Withdrawn | Final | Superseded>
` Type: `<Standards Track (Core, Networking, Interface, ERC) | Informational | Process>
` Type: `<Standards Track (Core, Networking, Interface, GRC) | Informational | Process>
` Created: `<date created on, in ISO 8601 (yyyy-mm-dd) format>
@@ -151,7 +151,7 @@ Note: The Resolution header is required for Standards Track GIPs only. It contai
While an GIP is in private discussions (usually during the initial Draft phase), a Discussions-To header will indicate the mailing list or URL where the GIP is being discussed. No Discussions-To header is necessary if the GIP is being discussed privately with the author.
The Type header specifies the type of GIP: Standards Track, Meta, or Informational. If the track is Standards please include the subcategory (core, networking, interface, or ERC).
The Type header specifies the type of GIP: Standards Track, Meta, or Informational. If the track is Standards please include the subcategory (core, networking, interface, or GRC).
The Created header records the date that the GIP was assigned a number. Both headers should be in yyyy-mm-dd format, e.g. 2001-08-14.
@@ -183,8 +183,6 @@ The current GIP editors are
* Mark Beylin (@mbeylin)`
GIP Editor Responsibilities and Workflow
--------------------------------------
@@ -212,7 +210,7 @@ Once the GIP is ready for the repository, the GIP editor will:
- Send a message back to the GIP author with next step.
Many GIPs are written and maintained by developers with write access to the Ethereum codebase. The GIP editors monitor GIP changes, and correct any structure, grammar, spelling, or markup mistakes we see.
Many GIPs are written and maintained by developers with write access to the Gitcoin codebase. The GIP editors monitor GIP changes, and correct any structure, grammar, spelling, or markup mistakes we see.
The editors don't pass judgment on GIPs. We merely do the administrative & editorial part.
@@ -1,10 +1,12 @@
# GIPs
Gitcoin Improvement Proposals (GIPs) describe standards for the Gitcoin platform, including core protocol specifications, client APIs, community standards, and contract standards.
This process is a fork of [Ethereum EIPs](https://github.com/ethereum/GIPs).
This process is a fork of [Ethereum EIPs](https://github.com/ethereum/EIPs).
Discuss on [Gitcoin Slack](https://gitcoin.co/slack) in the <i>#community-GIPs</i> channel.
# Contributing
First review [GIP-1](GIPS/gip-1.md). Then clone the repository and add your GIP to it. There is a [template GIP here](gip-X.md). Then submit a Pull Request to Gitcoin's [GIPs repository](https://github.com/gitcoincoco/GIPs).
First review [GIP-1](GIPS/gip-1.md). Then clone the repository and add your GIP to it. There is a [template GIP here](gip-X.md). Then submit a Pull Request to Gitcoin's [GIPs repository](https://github.com/gitcoinco/GIPs).
# GIP status terms
* **Draft** - an GIP that is open for consideration
@@ -8,7 +8,7 @@ Note that an GIP number will be assigned by an editor. When opening a pull reque
Title: <GIP title>
Author: <list of authors' names and optionally, email addresses>
Type: <Standard Track | Informational | Meta>
Category (*only required for Standard Track): <Core | Networking | Interface | ERC>
Category (*only required for Standard Track): <Core | Networking | Interface | GRC>
Status: Draft
Created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
Requires (*optional): <GIP number(s)>

0 comments on commit 213c705

Please sign in to comment.