Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sambacha/generator-yyip
yeoman generator to create YIPs / yearn finance improvement proposals
https://github.com/sambacha/generator-yyip
defi ethereum idle-finance yearn yearn-finance yearn-improvement-proposals yfi yip
Last synced: 23 days ago
JSON representation
yeoman generator to create YIPs / yearn finance improvement proposals
- Host: GitHub
- URL: https://github.com/sambacha/generator-yyip
- Owner: sambacha
- License: apache-2.0
- Created: 2020-10-22T14:51:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-20T06:22:11.000Z (over 3 years ago)
- Last Synced: 2024-10-06T15:41:54.275Z (about 1 month ago)
- Topics: defi, ethereum, idle-finance, yearn, yearn-finance, yearn-improvement-proposals, yfi, yip
- Language: JavaScript
- Homepage:
- Size: 256 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
yYIPs - yEarn Improvement Proposals Generator (yeoman)
[](https://twitter.com/iearnfinance) [](https://discordapp.com/channels/734804446353031319/) [](https://t.me/yearnfinance)
[](https://github.com/sambacha/yyip/actions)
- [Abstract](#abstract)
- [Motivation](#motivation)
- [What is an YIP?](#what-is-an-yip-)
- [YIP Rationale](#yip-rationale)
- [Process of submitting a`YIP`](#process-of-submitting-a-yip-)
- [YIP Statuses](#yip-statuses)
- [Example YIP](#example-yip)
- [Validation](#validation)
- [Using the yYIP Generator](#using-the-yyip-generator)
- [Requirements](#requirements)
- [Install](#install)
- [Commands](#commands)
- [YIP Editors](#yip-editors)
- [Copyright](#copyright)
### TL;DR
`$ npm i generator-yyip -g`
`$ yo yyip`
## Demo
[](https://asciinema.org/a/369942)
## Abstract
The yEarn Improvement Proposals (`YIP`s) describe standards for the yEarn platform, including core protocol specifications, client APIs, and contract standards. This is the definitive, `cannonical` reference specification for the core logic.
## Motivation
`yYip` generator is a Yeoman generator to kickstart your yEarn Improvement Proposal, like strategies.
## What is an YIP?
YIP stands for yEarn Improvement Proposal, it has been adapted from the SIP (Synthetix Improvement Proposal). The purpose of this process is to ensure changes to yEarn are transparent and well governed. An YIP is a design document providing information to the yEarn community about a proposed change to the system. The author is responsible for building consensus within the community and documenting dissenting opinions.
## YIP Rationale
We intend YIPs to be the primary mechanisms for proposing new features, collecting community input on an issue, and for documenting the design decisions for changes to yEarn. Because they are maintained as text files in a versioned repository, their revision history is the historical record of the feature proposal.
It is highly recommended that a single YIP contain a single key proposal or new idea. The more focused the YIP, the more successful it is likely to be.
An YIP must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement.
#### Process of submitting a`YIP`
1. Review [YIP-0](YIPS/yip-0.md).
2. Fork the repository by clicking "Fork" in the top right.
3. Add your YIP to your fork of the repository. There is a [template YIP here](yip-X.md).
4. Submit a Pull Request to yEarn's [YIPs repository](https://github.com/iearn-finance/YIPS/).
Your first PR should be a first draft of the final YIP. It must meet the formatting criteria enforced by the build (largely, correct metadata in the header). An editor will manually review the first PR for a new YIP and assign it a number before merging it. Make sure you include a `discussions-to` header with the URL to a new thread on [gov.yearn.finance](https://gov.yearn.finance/) where people can discuss the YIP as a whole.
> Note: It is important that their be community support behind a proposed `YIP` - It is up to the author(s) to shepard their proposal through the process
If your YIP requires images, the image files should be included in a subdirectory of the `assets` folder for that YIP as follow: `assets/yip-X` (for yip **X**). When linking to an image in the YIP, use relative links such as `../assets/yip-X/image.png`.
When you believe your YIP is mature and ready to progress past the WIP phase, you should ask to have your issue added to the next governance call where it can be discussed for inclusion in a future platform upgrade. If the community agrees to include it, the YIP editors will update the state of your YIP to 'Approved'.
## YIP Statuses
**WIP** - a YIP that is still being developed.
**Proposed** - a YIP that is ready to be reviewed in a governance call.
**Approved** - a YIP that has been accepted for implementation by the yEarn community.
**Implemented** - a YIP that has been released to mainnet.
**Rejected** - a YIP that has been rejected.
**Withdrawn** - a YIP that has been withdrawn by the author(s).
**Deferred** - a YIP that is pending another YIP/some other change that should be bundled with it together.
**Moribund** - a YIP that was implemented but is now obsolete and requires no explicit replacement.
### Example YIP
```diff
-Status: Proposed
+Status: Approved
YIP: integer,
Created: 2020-09-01
-Last-Modified: 2020-09-03
+Last-Modified: 2020-09-08
```
## Validation
YIPs MUST pass some validation tests. The YIP repository ensures this by running tests using [html-proofer](https://rubygems.org/gems/html-proofer) and [yip_validator](https://rubygems.org/gems/yip_validator).
It is possible to run the YIP validator locally:
```ruby
gem install yip_validator
yip_validator
```
## Using the yYIP Generator
Follow instructions below to install
#### Requirements
- nodejs 10+
- npm 5+
- yeoman generator
#### Install
```bash
npm install -g yo
```
```bash
yo yip
```
#### Commands
Follow the commands in your terminal / console
## YIP Editors
The current YIP editors are:
`* Artem K (@banteg)`
`* Cooper Turley (@Cooopahtroopa)`
`* Daryl Lau (@Daryllautk)`
`* Klim K (@milkyklim)`
`* Sunil Srivatsa (@alphastorm)`
## Copyright
yYIP: Apache-2.0
YIPS: Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).