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

Create vip template #467

Merged
merged 3 commits into from
Nov 14, 2017
Merged

Conversation

DavidKnott
Copy link
Contributor

- What I did

Create VIP (Viper Improvement Proposal) template to facilitate discussion around the addition features to Viper.

- How I did it

I looked at the Ethereum EIP (Ethereum Improvement Proposal) template and took what I felt would be relevant for Viper

- How to verify it

Read the template

- Description for the changelog

None

- Cute Animal Picture

image

Copy link
Contributor

@chgue chgue left a comment

Choose a reason for hiding this comment

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

Great idea! Found two small errors. Linking this in the docs/contribution guidelines would be beneficial I think.

"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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Small typo: "("

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Small typo: "solves. as well"

@DavidKnott
Copy link
Contributor Author

@chgue Made the changes you requested and added a link to it in contributing.rst
Thanks for the feedback!

@@ -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`_
Copy link
Contributor

Choose a reason for hiding this comment

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

@DavidKnott Thanks for adding it to the docs! There is a closing ">" missing before the "`" here and in the change below.

@DavidKnott
Copy link
Contributor Author

@chgue Great catch, I added the >, merging it in.

@DavidKnott DavidKnott merged commit 14ed6cd into vyperlang:master Nov 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants