Please note: This repo is a work in progress, I've pushed it public for performance testing and feedback. Over the next week or so I will finalise the content in the /create and /about sections. Feel free to report any bugs or issues. Feedback welcome. Just remember it's not finished. There's stuff on the roadmap…
There are two ways to contribute. You don't need to be able to code but you will need a (free) GitHub account in order to contribute.
Firstly you'll have to format your design principles a certain way. Not all fields are necessary, if something is missing (for example author:
or summary:
) just leave it blank.
Here's the template, copy it from here into a simple text editor of your choice. Replace the things you want to add as described below:
---
title: #add title#
author: #add author#
overview:
link: #add full url#
principles:
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
- principle: #add a principle#
summary: |
#add a summary (optional)#
---
Navigate to the _examples
folder at the top of this page.
Click on "Create new file" at the top right
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
)
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:
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
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.
Give it a quick glance, make sure everything looks ok
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.
Checkout the this repo and fire up jekyll (more instructions to follow in the next few days)
New features and improvements are welcome but please submit a discussion thread before you attempt or commit anything.
layout:
ignore this
title:
The title of this example, e.g. "The Five Principles of Design"
author:
The company, team or individual that created these principles
link:
A link to a source article or somewhere the original principles were created.
principles:
— principle:
Each principle on a new line
tags:
Add tags, separated by a comma. Tags aren't available on the site yet but will be soon. It's a good idea to add them in preparation. The proposed tags are:
Organistion
Personal
Product
AI
UX
Accessibility
Universal
Specific
Notes:
Troubleshooting - when bundle update throws An error occurred while installing commonmarker (0.17.6), and Bundler cannot continue. Make sure that `gem install commonmarker -v '0.17.6'` succeeds before bundling.
brew install cmake