CONTRIBUTING.md

Contributing Guide

This is part of the Porter project. If you are a new contributor, check out our New Contributor Guide. The Porter Contributing Guide also has lots of information about how to interact with the project.

---

• Initial setup
• Magefile explained

---

Initial setup

You need to have porter installed first. Then run mage build install. This will build and install the mixin into your porter home directory.

Magefile explained

Here are common Magefile tasks:

• build compiles all the go code.
• test runs all the tests.