Skip to content
This repository has been archived by the owner on Jan 18, 2023. It is now read-only.

Latest commit

 

History

History
34 lines (27 loc) · 2.1 KB

README.md

File metadata and controls

34 lines (27 loc) · 2.1 KB

STIPS

Set Protocol Technical Improvement Proposals - Propose protocol improvements and track development process from specification to deployment.

Introduction

This repo contains the formalized process for adding technical features to Set Protocol. The intention is for this repo to contain all information about the progress of new features as they go from ideation, to specification, to implementation, and deployment. Technical features may include:

  • new SetTokens
  • new Modules
  • new Adapters
  • any other feature that may require protocol governance to add

Repo Setup

  • All STIPS past and present can be found in the STIPS folder
  • Any assets for a given STIP can be found in the assets folder
  • The Issues tab contains potential ideas that have not been formalized into a STIP

Contributing

  1. Review STIP-TEMPLATE.md to familiarize yourself with the STIP process
  2. Fork the repository by clicking "Fork" in the top right.
  3. Add your STIP to your fork of the repository. There is a template STIP here.
  4. Submit a pull request in this repository

It's important to follow the STIP Template guidelines, when first opened, a STIP should only include a summary of the problem/feature and any background information relevant to the problem. If any images or graphs need to be added they can be added to the assets/STIP-xx folder where xx is the STIP's assigned number.

For tracking purposes it's important that each step of the STIP is merged sequentially, that's not to say you can't work ahead locally, but we want to be sure all concerned parties have been able to review and approve every step along the way.

Using Markdown

Most IDEs have options for previewing the generated .md file locally:

Additional resources for working with Markdown: