Voi Improvement Proposals (VIP)

Table Of Contents

• 1. Overview
• 2. Documentation
• 3. Usage
  • 3.1. Fork The Repo
  • 3.2. Create A New VIP
  • 3.3. Open A PR
• 4. Development
  • 4.1. Overview
  • 4.2. Requirements
  • 4.3. Setup
  • 4.4. Run Locally
  • 4.5. Build (optional)
• 5. Appendix
  • 5.1. Useful Commands
• 6. How To Contribute
• 7. License
• 8. Credits

🗂️ 1. Overview

This serves as a repository for the Voi ecosystem proposals and a staging point (via GitHub issues) for discussion around said proposals.

^{Back to top ^}

📚 2. Documentation

The VIP documentation is hosted here.

^{Back to top ^}

🪄 3. Usage

3.1. Fork The Repo

Before creating and submitting a VIP, you will need to fork this repo.

^{Back to top ^}

3.2. Create A New VIP

⚠️ NOTE: It is RECOMMENDED you read VIP-00-0000 in order to understand the guidelines around VIPs.

When you have decided on the category and the indexing of your proposed VIP, copy the vip-template.md into the vips/<category>/<index>/ directory (where category is the category index and index is the VIP index).

⚠️ NOTE: Your VIP index directory MUST use padded zeroes if your index is below 1000, e.g. if your index is 27, the directory to create will be 0027/..

^{Back to top ^}

3.3. Open A PR

Once you are ready for the VIP to be reviewed and open for discussion, open a PR from the forked repo against the main branch and ensure the PR title is in the format:

VIP-##-####: Title

The first digits (after VIP-), will be the number of category, followed by the index of your VIP, and then the capitalized title.

For example: VIP-03-0200: Fungible Tokens.

💡 TIP: For more information on contributing, see here.

^{Back to top ^}

🛠 4. Development

4.1. Overview

While the VIPs are essentially a collection of markdown files, the static site that host the VIPs is built using Hugo (which is built in Go).

While it is not necessary to run an instance of Hugo to write an VIP, you can see how the VIP will render.

^{Back to top ^}

4.2. Requirements

• Install Go v1.22.6+
• Install Make

4.3. Setup

1. A few Go dependencies are required which can simply be installed using:

make install

^{Back to top ^}

4.4. Run Locally

1. To run a local build, you can simply use:

make start

2. Navigate to http://localhost:8080.

^{Back to top ^}

4.5. Build (optional)

1. To build locally, you can simply run:

make build

2. Navigate to http://localhost:8080.

^{Back to top ^}

📑 5. Appendix

5.1. Useful Commands

Command	Description
make build	Builds the docs to the public/ directory.
make install	Installs the required dependencies.
make start	Starts a local server, using hugo, that is accessible at http://localhost:8080.

^{Back to top ^}

👏 6. How To Contribute

Please read the Contributing Guide to learn about the development process.

^{Back to top ^}

📄 7. License

Please refer to the LICENSE file.

🎉 8. Credits

• Ethereum Improvement Proposals (EIPs): The format and processes borrow heavily from EIP, and they deserve a great amount of credit for the extensive work the authors have contributed.

^{Back to top ^}