Giter VIP home page Giter VIP logo

improvement-proposal-boilerplate's Introduction

Improvement Proposal Overview Title

Boilerplate Improvement Proposal Project Git Repo README file

Overview

This is the overview explanation of the proposal project/improvement. Explain the purpose of the improvement.

Tested Against:

Version Build Date
(yyyy-mm-dd)
Version 0.6.4 MDc6UmVsZWFzZTI0MzgwNTQ3 2020-03-10T15:26:16Z

Proposal Responsibility:

Person Contact Info Responsibility
@github_usrname usr@github_email.com Proposal Submitter
@github_dev1 [email protected] Developer

Files

Explain what is the purpose of each process and process related file in the project.

Click to see file details:

IYIPX.sol

This file does something and its purpose is to do abc.


deploy-mainnet.sh

This file deploys the contracts on mainnet


myEmailTemplate.ftl

This file does something and its purpose is to do abc.

Image example of the Rendered FreeMarker file (if applicable)


How to Deploy

Explanation of how to deploy this specific project goes here.

For further deployment templates and options see: Deployment Documentation

Method Trigger
Truffle On creation of a Production Release.
Deployed to mainnet chainid: 1
Web3 Provider On commit to branch with pattern build/development.
Deployed to testnet ropsten

Change Log

Store details about the releases of your improvement in the Change Log

Improvement Change Log

Other Information

Explanation of other details about the project that may not have been included in the Overview.

Examples:

  1. Use cases.
  2. Error handling.
  3. If there is re-usable code that could be used for other purposes.
  4. Explanation of any specific configurations, in-line code or expressions in any of the process files.
  5. Explanation of designs and specific configurations.
  6. Related documentation that may be contained in another system or the /docs folder.

Additional Support documentation

See the following for additional support documentation related to building and managing process projects:

  1. Best Practices and Documentation Patterns
  2. Helper Scripts and Snippets

Terminology

A list of terms used by this project.

Term Acronym Definition
Requestor
Initiator Another term used for requestor.
Protocol
Proxy
Margin Rate
Stablecoin
Tether USDT USDT Stablecoin

License

SPDX-License-Identifier: CC0-1.0

improvement-proposal-boilerplate's People

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.