Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

28 lines (22 sloc) 1.223 kB
layout title permalink
default
Contributing a Guide
contributing

Contributing a Guide

The guides site uses jekyll to power the site and all the documents are written using markdown. To contribute a guide, you just need to follow these simple steps.

  1. Fork the repository on github by clicking on the "Fork" button.
  2. Do a git clone of your fork.
  3. Create a file named YYYY-MM-DD-guide_name.markdown inside the _posts directory of your fork.

4. In this file, you'll need to add some YAML front matter at the top of the file so it looks like this:{% highlight yaml %}

layout: default title: Name of the Guide

permalink: one-word-summary.html

{% endhighlight %} 5. Commit this new guide to your git repo. 6. After you commit, push that to your fork. 7. You can now open a pull request explaining your guide. That's it!

You can follow the structure of our Rails Girls App Tutorial.

Thanks so much for taking the time to help us make Rails Girls awesome.

Jump to Line
Something went wrong with that request. Please try again.