Skip to content

RuGenerous/RIPS

Repository files navigation

RIPs

Validate Discord Telegram (https://twitter.com/rugenerous)

Visit the Governance Proposal Documentation Webpage

Rugenerous DAO Improvement Proposals (RIPs) describe standards for the Rugenerous platform, including:

  • core protocol specification
  • client APIs
  • contract standards
  • governance operations
  • and more

Contributing

  1. Review RIP-0.
  2. Fork the repository by clicking "Fork" in the top right.
  3. Add your RIP to your fork of the repository. There is a template RIP here.
  4. Submit a Pull Request to Rugenerous's RIPs repository.

Your first PR should be a first draft of the final RIP. 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 RIP 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.rug.farm where people can discuss the RIP as a whole.

If your RIP requires images, the image files should be included in a subdirectory of the assets folder for that RIP as follow: assets/rip-X (for rip X). When linking to an image in the RIP, use relative links such as ../assets/rip-X/image.png.

When you believe your RIP 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 RIP editors will update the state of your RIP to 'Approved'.

RIP Statuses

  • WIP - a RIP that is still being developed.
  • Proposed - a RIP that is ready to be reviewed in a governance call.
  • Approved - a RIP that has been accepted for implementation by the Rugenerous community.
  • Implemented - a RIP that has been released to mainnet.
  • Rejected - a RIP that has been rejected.
  • Withdrawn - a RIP that has been withdrawn by the author(s).
  • Deferred - a RIP that is pending another RIP/some other change that should be bundled with it together.
  • Moribund - a RIP that was implemented but is now obsolete and requires no explicit replacement.

Validation

RIPs must pass some validation tests. The RIP repository ensures this by running tests using html-proofer and rip_validator.

It is possible to run the RIP validator locally:

gem install yip_validator
yip_validator <INPUT_FILES>

RIP Generator

A RIP Generator is available as a nodejs package here.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages