Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 1.57 KB

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by writing or editing documentation
  • by writing specifications
  • by writing code ( no patch is too small : fix typos, add comments, clean up inconsistent whitespace )
  • by refactoring code
  • by closing issues
  • by reviewing patches

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a topic branch. git checkout -b local_topic_branch
  3. Implement your feature or bug fix.
  4. Add, commit, and push your changes. To push your topic branch use git push -u origin local_topic_branch.
  5. Submit a pull request.