Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (36 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.93 KB

How to Contribute

We very much welcome contributions to Wisper.

Getting started

Please first check the existing Issues and Pull Requests to ensure your issue has not already been discused.

Bugs

Please submit a bug report to the issue tracker, with the version of Wisper and Ruby you are using and a small code sample (or better yet a failing test).

Features

Please open an issue with your proposed feature. We can discuss the feature and if it is acceptable we can also discuss implimentation details. You will in most cases have to submit a PR which adds the feature.

We also have a Gitter channel.

Wisper is a micro library and will remain lean. Some features would be most appropriate as an extension to Wisper.

Questions

Try the Wiki first, the examples and how to sections have lots of information.

Please ask questions on StackOverflow, tagged wisper.

Feel free to ping me the URL on Twitter.

We also have a channel on Gitter.

Pull requests

  • Fork the project, create a new branch from v1 or master.
  • Squash commits which are related.
  • Write a good commit message
  • Documentation only changes should have [skip ci] in the commit message
  • Follow existing code style in terms of syntax, indentation etc.
  • Add an entry to the CHANGELOG
  • Do not bump the VERSION, but do indicate in the CHANGELOG if the change is not backwards compatible.
  • Issue a Pull Request

Versions

The v1 branch is a long lived branch and you should branch from this if you wish to fix an issue in version ~> 1.0.

The master branch will target the next version of Wisper.