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.

If you want to add a new guide:

• Create a file named guide_name.md inside the _pages directory of your fork.

• In this file, you’ll need to add some YAML front matter at the top of the file so it looks like the following example, taken from this guide that you are currently viewing:

    ---
    layout: guide
    title: Contributing a Guide
    permalink: contributing
    ---

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

If you want to improve an existing guide:

Make the change in the file you want to change! You don’t need to make a new file if you want to change something in an existing file.

Then…

1. Commit this new guide to your Git repo.
2. After you commit, push that to your fork.
3. You can now open a pull request explaining your guide. That’s it!

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