Skip to content

Latest commit

 

History

History
22 lines (13 loc) · 995 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (13 loc) · 995 Bytes
Raw

How to contribute

I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.

Submitting changes

Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include RSpec examples. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

  • We indent using two spaces (soft tabs)
  • others to come soon...

Thanks