-
-
Notifications
You must be signed in to change notification settings - Fork 836
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #467 from DavidKnott/create-vip-template
Create vip template
- Loading branch information
Showing
3 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
This is the suggested template for new VIPs. | ||
|
||
## Preamble | ||
|
||
VIP: <to be assigned> | ||
Title: <VIP title> | ||
Author: <list of authors' names and optionally, email addresses> | ||
Type: <Standard Track | Informational | Meta> | ||
Status: Draft | ||
Created: <date created on, in ISO 8601 (yyyy-mm-dd) format> | ||
Requires (*optional): <VIP number(s)> | ||
Replaces (*optional): <VIP number(s)> | ||
|
||
|
||
## Simple Summary | ||
"If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the VIP. | ||
|
||
## Abstract | ||
A short description of the technical issue being addressed. | ||
|
||
## Motivation | ||
The motivation is critical for VIPs that add or change Viper's functionality. It should clearly explain why the existing Viper functionality is inadequate to address the problem that the VIP solves as well as how the VIP is in line with Viper's goals and design philosopy. | ||
|
||
## Specification | ||
The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow any developer to implement the functionality | ||
|
||
## Backwards Compatibility | ||
All VIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The VIP must explain how the author proposes to deal with these incompatibilities. | ||
|
||
## Copyright | ||
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters