From 04c78c8c339c4aa4e61f1116305e75cad57d5cdc Mon Sep 17 00:00:00 2001 From: Ted Nyman Date: Sun, 10 Nov 2013 17:57:43 -0800 Subject: [PATCH] Bit more README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76948111..80ab56c0 100644 --- a/README.md +++ b/README.md @@ -83,18 +83,18 @@ To run the tests: ## Contributing -The majority of patches won't need to touch any Ruby code at all. The [master language list](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) is just a configuration file. +The majority of contributions won't need to touch any Ruby code at all. The [master language list](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) is just a YAML configuration file. We try to only add languages once they have some usage on GitHub, so please note in-the-wild usage examples in your pull request. Almost all bug fixes or new language additions should come with some additional code samples. Just drop them under [`samples/`](https://github.com/github/linguist/tree/master/samples) in the correct subdirectory and our test suite will automatically test them. In most cases you shouldn't need to add any new assertions. -To update the samples.json after adding new files to [`samples/`](https://github.com/github/linguist/tree/master/samples): +To update the `samples.json` after adding new files to [`samples/`](https://github.com/github/linguist/tree/master/samples): bundle exec rake samples ### Testing -Sometimes getting the tests running can be too much work, especially if you don't have much Ruby experience. It's okay, be lazy and let our build bot [Travis](http://travis-ci.org/#!/github/linguist) run the tests for you. Just open a pull request and the bot will start cranking away. +Sometimes getting the tests running can be too much work, especially if you don't have much Ruby experience. It's okay: be lazy and let our build bot [Travis](http://travis-ci.org/#!/github/linguist) run the tests for you. Just open a pull request and the bot will start cranking away. Here's our current build status, which is hopefully green: [![Build Status](https://secure.travis-ci.org/github/linguist.png?branch=master)](http://travis-ci.org/github/linguist)