Contributing

There are a couple of ways you can contribute to this project.

Suggestions

If you just have a suggestion for a demo, or something that think should be changed or added, add a New Issue describing your suggestion, and we can discuss it and/or implement it, if it makes sense.

Basics

• Everything in the site should be sorted by complexity, whenever possible, with the simplest items at the top, and more complex items further down.
• Files should be places in their appropriate folders ('_concepts' for Concepts, '_proofs' for Proofs), and their filename should be the page's title, slugified, with '.md' as the extension.
• Example: _proofs/1-to-1-collision.md
• Concepts and Proofs use Front Matter to be rendered properly. Each file must contain the following front-matter at the top of the file:

---
title: Title        # The pages title
order: 1            # {the position in the list it should show up}
tags: [tag1, tag2]  # tags that this page should be grouped under
complexity: 1       # 1 (Beginner), 2 (Medium), or 3 (Advanced) for how complex this item is 
---

• Although we strongly encourage using Markdown for your pages, you can use HTML if it is absolutely necessary.
• You may use Jekyll's Liquid Tags in your pages.
• When mentioning a HaxeFlixel API term, you should use the "api" tag, which will format the term and add a tooltip and link to the HaxeFlixel API

Example	Result	Links To
{% api flixel.FlxObject %}	"FlxObject"	http://api.haxeflixel.com/flixel/FlxObject.html
{% api flixel.FlxObject.velocity %}	"velocity"	http://api.haxeflixel.com/flixel/FlxObject.html#velocity
{% api flixel.FlxObject.overlaps() %}	"FlxObject.overlaps()"	http://api.haxeflixel.com/flixel/FlxObject.html#overlaps
{% api flixel.FlxObject.ANY %}	"FlxObject.ANY"	http://api.haxeflixel.com/flixel/FlxObject.html#ANY

Contributing Concepts, Proofs, and Demos

If you would like to add your own content to the site, we have tried to make the process as easy as possible, but there are some guidelines that must be followed.

Concepts

Concepts are high-level 'ideas' that can be broken down into a few, smaller proofs. Before adding a new Concept, ask yourself if it is appropriate. Concepts should never be too broad ("Game"), or too specific ("Camera Flash"). There should never be any duplicates. If in doubt, create an issue and discuss it, first.