Skip to content

Adding an example

Ben Brignell edited this page Jan 31, 2018 · 6 revisions

Getting started

Adding an example the easy way

Navigate to the _examples folder at the top of this page.

screenshot-2017-12-04 11 27 37

Create a new file

Click on "Create new file" at the top right

screenshot-2017-12-04-11 29 20

Name your file

You'll see an empty text area to paste your design principles into. At the top is a field for you to name your file. Give it a descriptive file name (for example here I'm adding the example "Design Well Inc's" design principles and have called the file design-well-in.md)

screenshot 2017-12-04 11 30 54

Paste in your Design Principles

Paste in your design principles. You'll need to format them based on a template which if you don't have it yet can be found here:

screenshot 2017-12-04 11 36 07

Add your new file

Scroll down to the bottom of the text area and 'Propose new file'. Give this a message, for example added example design-well-inc.md

screenshot 2017-12-04 11 36 58

Create pull request

A pull request is something that's created for somebody to review your contribution and check everything is ok. If it's ok it will be merged into the site, if there's a problem somebody will fix it or let you know.

screenshot 2017-12-04 11 37 21

Confirm pull request

Give it a quick glance, make sure everything looks ok

screenshot 2017-12-04 11 37 38

Once a pull request is made it will be reviewed and if everything is ok it'll be merged in and appear on the site. It may take a few days for this to happen.

Adding an example the hard way

Checkout the this repo and fire up jekyll (more instructions to follow in the next few days)