Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

32 lines (26 loc) · 1.03 KB
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.

Add a new repository

  1. Add a new file named after the repository under /vanity/code. For example, if the vanity import path is get.porter.sh/mixin/stuff, add a new page /vanity/code/mixin/stuff.md.
  2. Add the frontmatter and customize it to match the new repository: 
    ---
title: "Stuff Mixin"
vanity: "https://github.com/getporter/stuff-mixin"
url: "/mixin/stuff/"

Preview the site

  1. cd vanity
  2. hugo serve
  3. open http://localhost:1313
  4. Try out a URL that you are adding, for example http://localhost:1313/mixin/stuff. Verify that it redirects to the correct GitHub repository.