Permalink
Browse files

add the start of a contribution guide

  • Loading branch information...
1 parent bdfa55f commit 3a9f622eda71c5cfd7f7aba1fa99cdf110afbf46 @hone hone committed Apr 19, 2012
Showing with 27 additions and 1 deletion.
  1. +26 −0 _posts/2012-04-19-contributing.markdown
  2. +1 −1 index.html
View
26 _posts/2012-04-19-contributing.markdown
@@ -0,0 +1,26 @@
+---
+layout: default
+title: Contributing a Guide
+permalink: contributing.html
+---
+# Contributing a Guide
+
+The guides site uses [jekyll](https://github.com/mojombo/jekyll) to power the site and all the documents are written using [markdown](http://daringfireball.net/projects/markdown/). To contribute a guide, you just need to follow these simple steps.
+
+1. Fork the [repository on github](https://github.com/railsgirls/railsgirls.github.com) 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](https://github.com/railsgirls/railsgirls.github.com/blob/master/_posts/2012-04-18-app.markdown).
+
+Thanks so much for taking the time to help us make Rails Girls awesome.
View
2 index.html
@@ -37,7 +37,7 @@
</li>
<li>
<i>?</i>
- <h3>Submit Your Own Guide</h3>
+ <h3><a href="contributing">Submit Your Own Guide</a></h3>
<p>We are accepting guides to extend the application to our <a href="http://github.com/railsgirls/railsgirls.github.com">Github repository &rarr;</a></p>
</li>
</ul>

0 comments on commit 3a9f622

Please sign in to comment.