-
-
Notifications
You must be signed in to change notification settings - Fork 834
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
Create vip template #467
Conversation
There was a problem hiding this 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.
.github/VIP_TEMPLATE.md
Outdated
"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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small typo: "("
.github/VIP_TEMPLATE.md
Outdated
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. |
There was a problem hiding this comment.
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"
d0521d8
to
bb3f546
Compare
@chgue Made the changes you requested and added a link to it in |
docs/contributing.rst
Outdated
@@ -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`_ |
There was a problem hiding this comment.
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.
bb3f546
to
b4625db
Compare
b4625db
to
132d337
Compare
@chgue Great catch, I added the |
- 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