Skip to content

Commit

Permalink
Merge pull request #467 from DavidKnott/create-vip-template
Browse files Browse the repository at this point in the history
Create vip template
  • Loading branch information
DavidKnott authored Nov 14, 2017
2 parents 36e926d + 132d337 commit 14ed6cd
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
If you're proposing a new feature please follow the [VIP Template] (https://github.com/ethereum/viper/tree/master/.github/VIP_TEMPLATE.md)

* viper Version: x.x.x
* pyethereum Version: x.x.x
* OS: osx/linux/win
Expand Down
31 changes: 31 additions & 0 deletions .github/VIP_TEMPLATE.md
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/)
8 changes: 8 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,18 @@ In particular, we need help in the following areas:
* Responding to questions from other users on `StackExchange
<https://ethereum.stackexchange.com>`_ and the `Viper Gitter
<https://gitter.im/ethereum/viper>`_
* Suggesting Improvements
<https://github.com/ethereum/viper/tree/master/.github/VIP_TEMPLATE.md>`_
* Fixing and responding to `Viper's GitHub issues
<https://github.com/ethereum/viper/issues>`_


How to Suggest Improvements
===========================

To suggest an improvement, please create a Viper Improvement Proposal (VIP for short)
using the `VIP Template <https://github.com/ethereum/viper/tree/master/.github/VIP_TEMPLATE.md>`_.

How to Report Issues
====================

Expand Down

0 comments on commit 14ed6cd

Please sign in to comment.