forked from hound-search/hound
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |