Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) · 1.02 KB

Contributing to Hound

We welcome (and appreciate) contributions from the community! Give this guide a quick read to ensure your contribution goes as smoothly as possible.

Submitting contributions

If you're just getting started, this guide will help get you started hacking on hound.

Once you're ready, open a pull request with a clear description of your changes (you can read more about pull requests on GitHub here).

When you send a pull request, please be sure to include:

  • unit tests that validate that your changes work as expected (both for Go and for JavaScript changes)
  • concise code comments (it can help to imagine that you're explaining your code to a total stranger)
  • one or more examples, if necessary.

More

Hound is a volunteer effort. We do our best to try and review contributions in a timely manner. Any code or feedback you share with us is hugely appreciated.