contributing.textile

layout	title
documentation	Contributing

Documentation

MongoMapper needs your help to make the documentation better. Here’s how to contribute:

1. Fork the repo on GitHub and check out the gh-pages branch.
   {% highlight sh }
   $ git checkout -b gh-pages origin/gh-pages
   { endhighlight %}
2. Install the Jekyll and RedCloth gems
   {% highlight sh }
   $ gem install jekyll RedCloth
   { endhighlight %}
3. Install Pygments
   {% highlight sh }
   $ sudo easy_install Pygments
   { endhighlight %}
4. Run the Jekyll server
   {% highlight sh }
   jekyll serve —watch
   { endhighlight %}
5. Open up http://localhost:4000/ in your web browser
6. Make your documentation changes
7. Push your changes and submit a pull request

Suggestions

If you want to help with the documentation, but don’t know how to help, here are some ideas of things that need documented.

Guidelines

In order to maintain quality, here are some guidelines for contributing to the MongoMapper documentation.

• Don’t document hacks or workarounds. If MongoMapper is broken or doesn’t support something, note it in the docs and add an issue to the issue tracker.
• Avoid narratives. People don’t really care why you’re writing the documentation, they just want to know how to use MongoMapper.
• Be concise without sacrificing clarity.