Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 907 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 907 Bytes
Raw

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

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 the most common Magefile tasks:

  • build builds both the runtime and client.
  • install installs the mixin into ~/.porter/mixins.
  • testUnit runs the unit tests.