Contributing

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

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions. :floppy_disk: :cd: :egg:
  • by reporting bugs. :scream: :laughing:
  • by suggesting new features. :nose: :bulb: :new: :pizza:
  • by writing or editing documentation. :clipboard: :orange_book: :books:
  • by writing code (no patch is too small: fix typos, add comments). :wink: :confused: :tired_face: :smirk: :white_check_mark:
  • by refactoring code. :open_mouth: :speak_no_evil:
  • by closing issues. :hash:
  • by reviewing patches. :+1: :-1:
  • by writing blog posts. :memo: :newspaper:

Submitting an Issue

We use the :octocat: GitHub issue tracker to track :beetle: bugs and :bomb: features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. Otherwise feel free to create a :hash: new issue.

Submitting a Pull Request

  1. Fork the official repository. :fearful:
    Run ./bin/dev_setup.sh to get started with development.
  2. Create a topic branch. :frowning:
  3. Implement your feature or bugfix. :smile:
  4. Add, commit, and push your changes. :sunglasses:
  5. Submit a pull request. :smirk:

Inspired by https://github.com/jfelchner/ruby-progressbar/blob/b837c09ea1e34923d984ab47bd47ef095fcb5a92/CONTRIBUTING.md