Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.04 KB

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 make build install. This will build and install the mixin into your porter home directory.

Makefile explained

Here are the most common Makefile tasks

  • build builds both the runtime and client.
  • install installs the mixin into ~/.porter/mixins.
  • test-unit runs the unit tests.
  • clean-packr removes extra packr files that were a side-effect of the build. Normally this is run automatically but if you run into issues with packr, run this command.