Skip to content

Contributing

Mike edited this page Oct 26, 2015 · 1 revision

Forks and PRs are welcome!

A couple things:

  1. If you're adding or modifying the public API at all, please ask first, preferably in an issue. If you're squashing a bug or optimizing something behind the scenes, you don't need to ask first, go right ahead, but I'm very hesitant to modify (even add to) the existing API.
  2. Try to stay with the conventions used in the library, with obvious things like code style (whitespace, naming rules, etc.) but also how listeners are managed, error handling, etc.
  3. This might sounds a little less than reasonable since I haven't held to this, but please write and include unit tests for any changed pieces.

TYIA!

Clone this wiki locally