Contributing To OmniAuth

sferik edited this page Apr 23, 2011 · 5 revisions

If you would like to contribute to OmniAuth, here's the process you should follow:

  1. Fork the project.
  2. Make your fixes/changes. Document them nicely.
  3. Do not change gem version numbers.
  4. If adding a provider, add it to the list in README.markdown.
  5. Submit your pull request as an issue to the official repository. We'll get to it as soon as we can.

Development Environment

Bootstrap gems

You need bundler to get started:

gem install bundler

Install all dependencies

Once you have bundler installed, you can install all development dependencies with:

bundle install

Run the tests

If all is well, you should have a green run

bundle exec rake spec

Start writing code!

If you are creating a new strategy, please take a look at the Strategy Contribution Guide for more information about specific requirements.

Documentation

OmniAuth utilizes YARD for documentation generation with Markdown as the documentation format. When contributing, please keep this in mind when writing any documentation. You can generate the documentation for all of OmniAuth by running rake doc in the root directory. Note: you must have the YARD gem installed for this to work. Documentation is generated for each new version and published to GitHub pages.