diff --git a/API.md b/API.md index 13874aa3..d166ee8f 100644 --- a/API.md +++ b/API.md @@ -43,7 +43,7 @@ In this query URL: * `.json` is the Format. Note the dot between the Endpoint and Format. Also note that, since JSON is the default output format, we didn't _have_ to specify it. * In keeping with standard [URI Query String syntax](https://en.wikipedia.org/wiki/Query_string), the `?` and `&` characters are used to begin and separate the list of query parameters. * `school.degrees_awarded.predominant=2,3` is a Field Parameter. In this case, it's searching for records which have a `school.degrees_awarded.predominant` value of either `2` or `3`. - * `_fields=id,school.name,2013.student.size` is an Option Parameter, as denoted by the initial underscore character. `_fields` is used to limit the output fields to those in the given list. We strongly recommend using the `_fields` parameter to reduce the amount of data returned by the API, thus increasing performance. + * `_fields=id, school.name, 2013.student.size` is an Option Parameter, as denoted by the initial underscore character. `_fields` is used to limit the output fields to those in the given list. We strongly recommend using the `_fields` parameter to reduce the amount of data returned by the API, thus increasing performance. ### JSON Output Example @@ -89,7 +89,7 @@ A successful query will return a JSON with two top-level elements: ### Error Example -Let's change the query so as to generate an error when it's executed: +Let's change the query to generate an error when it's executed: ``` https://api.data.gov/ed/collegescorecard/v1/schools.json?school.degrees_awarded.predominant=frog&_fields=id,school.name,wombat @@ -187,7 +187,7 @@ You can perform extra refinement and organisation of search results using **opti ### Limiting Returned Fields with `_fields` -By default, records returned in the query response include all their stored fields. However, you can limit the fields returned with the `_fields` option parameter. This parameter takes a comma-separated list of field names. For example: `_fields=id,school.name,school.state` will return result records that only contain those three fields. +By default, records returned in the query response include all their stored fields. However, you can limit the fields returned with the `_fields` option parameter. This parameter takes a comma-separated list of field names. For example: `_fields=id, school.name, school.state` will return result records that only contain those three fields. Requesting specific fields in the response will significantly improve performance and reduce JSON traffic, and is recommended. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c7c94f0..29c3be39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,8 @@ To run all the tests: Treat commit messages as an email message that describes what you changed and why. -The first line of the commit log must be treated as as an email +The first line of the commit log +as an email subject line. It must be strictly no greater than 50 characters long. The subject must stand on its own and not only make external references such as to relevant bug numbers. @@ -90,7 +91,7 @@ chances of your issue being dealt with quickly: * **Motivation for or Use Case** - explain why this is a bug for you * **Version(s)** - is it a regression? * **Browsers and Operating System** - is this a problem with all browsers or only IE8? -* **Reproduce the error** - provide a live example, screenshot, and/or a unambiguous set of steps. The more the better. +* **Reproduce the error** - provide a live example, screenshot, and/or an unambiguous set of steps. The more the better. * **Related issues** - has a similar issue been reported before? Reference the related issues in the descrioption. * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit). If you're requesting a feature, describe how the feature might work to resolve the user story. @@ -182,6 +183,6 @@ Anyone who reviews a pull request should leave a note to let others know that someone has looked at it. For larger commits, we like to have a +1 from someone else on the core team and/or from other contributor(s). Please note if you reviewed the code or tested locally -- a +1 by itself will typically be -interpreted as your thinking its a good idea, but not having reviewed in detail. +interpreted as your thinking it's a good idea, but not having reviewed in detail. [Google Group]: https://groups.google.com/d/forum/open-data-maker diff --git a/INSTALL.md b/INSTALL.md index 9766905d..c7ccba62 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -3,7 +3,7 @@ If you just want to install and run, then you can just download a [zip file](https://github.com/18F/open-data-maker/archive/master.zip). -You will still need the the dependencies below, but you don't need to +You will still need the dependencies below, but you don't need to clone the git repo for the source code. ## Install Prerequisites diff --git a/README.md b/README.md index 3a30eaf4..5a6a04bf 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ Here's how it might look in the future: ![Download all the data or make choices to create a csv with a subset](/doc/csv-download.png) ### Acknowledgements -Zipcode latitude and longitude provided by [GeoNames](http://www.geonames.org/) under under a [Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/). +Zipcode latitude and longitude provided by [GeoNames](http://www.geonames.org/) under a [Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/). ### Public domain