This repository has been archived by the owner on Dec 25, 2017. It is now read-only.
forked from ggreer/the_silver_searcher
-
Notifications
You must be signed in to change notification settings - Fork 25
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
13 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 |
---|---|---|
@@ -1,3 +1,16 @@ | ||
## Contributing | ||
|
||
I like when people send pull requests. It validates my existence. If you want to help out, check the [issue list](https://github.com/ggreer/the_silver_searcher/issues?sort=updated&state=open) or search the codebase for `TODO`. Don't worry if you lack experience writing C. If I think a pull request isn't ready to be merged, I'll give feedback in comments. Once everything looks good, I'll comment on your pull request with a cool animated gif and hit the merge button. | ||
|
||
### Running the test suite | ||
|
||
If you contribute, you might want to run the test suite before and after writing | ||
some code, just to make sure you did not break anything. Adding tests along with | ||
your code is nice to have, because it makes regressions less likely to happen. | ||
Also, if you think you have found a bug, contributing a failing test case is a | ||
good way of making your point and adding value at the same time. | ||
|
||
The test suite uses [Cram](https://bitheap.org/cram/). You'll need to build ag | ||
first, and then you can run the suite from the root of the repository : | ||
|
||
make test |