Skip to content

Commit

Permalink
Add CONTRIBUTING.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
dschott authored and dschott68 committed Mar 17, 2020
1 parent 3ea76c2 commit 3af56b5
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 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](https://github.com/hound-search/hound#hacking-on-hound).

Once you're ready, open a [pull request](https://github.com/hound-search/hound/compare) with a clear description of
your changes (you can read more about pull requests on GitHub [here](http://help.github.com/pull-requests/)).

When you send a pull request, please be sure to include:
- unit tests that validate that your changes work as expected
- consice code comments (it can help to imagine that you're explaining your code to a total stranger)
- an 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.

0 comments on commit 3af56b5

Please sign in to comment.