Skip to content

Commit

Permalink
rephrase 2nd sentence + various formatting tweaks
Browse files Browse the repository at this point in the history
1) Use [semantic linebreaks](http://rhodesmill.org/brandon/2012/one-sentence-per-line/)
2) Highlight values with bold
3) Rephrase the second sentence to make it clearer and shorter
4) Harmonize formatting of "possible values" lists
  • Loading branch information
waldyrious committed Oct 3, 2012
1 parent 9bbb05c commit 029d4c3
Showing 1 changed file with 43 additions and 38 deletions.
81 changes: 43 additions & 38 deletions Contributing.md
@@ -1,49 +1,54 @@
# Contributing to the caniuse data # Contributing to the caniuse data


The features-json directory includes JSON files for every feature found on the caniuse.com website. Through GitHub it provides a method for anyone interested in updating or contributing to the support data on the site. The features-json directory includes JSON files for every feature found on the caniuse.com website.
Maintaining these files on GitHub allows anyone to update or contribute to the support data on the site.


## How it works ## How it works


The data on the site is stored in a database. This data is periodically exported to the JSON files on GitHub. Once a change or new file here has been approved, it is integrated back into the database and the subsequent export files should be the same as the imported ones. Not too confusing, I hope. :) The data on the site is stored in a database.
This data is periodically exported to the JSON files on GitHub.
Once a change or new file here has been approved, it is integrated back into the database
and the subsequent export files should be the same as the imported ones.
Not too confusing, I hope. :)


## Supported changes ## Supported changes


Currently the following feature information can be modified: Currently the following feature information can be modified:
* "title" Feature title * **title**Feature name (used for the title of the table)
* "description" Brief description of feature * **description** Brief description of feature
* "spec" Spec URL * **spec** Spec URL
* "status" Spec status, one of the following: * **status** Spec status, one of the following:
* rec (W3C Recommendation) * `rec` - W3C Recommendation
* pr (W3C Proposed Recommendation) * `pr` - W3C Proposed Recommendation
* cr (W3C Candidate Recommendation) * `cr` - W3C Candidate Recommendation
* wd (W3C Working Draft) * `wd` - W3C Working Draft
* other (Non-W3C, but reputable) * `other` - Non-W3C, but reputable
* unoff (Unofficial or W3C "Note") * `unoff` - Unofficial or W3C "Note"
* "links" Array of "link" objects consisting of URL and short description of link * **links** Array of "link" objects consisting of URL and short description of link
* "bugs" Array of "bug" objects consisting of a bug description * **bugs** Array of "bug" objects consisting of a bug description
* "categories" Array of categories, any of the following: * **categories** Array of categories, any of the following:
* HTML5 * `HTML5`
* CSS * `CSS`
* CSS2 * `CSS2`
* CSS3 * `CSS3`
* SVG * `SVG`
* PNG * `PNG`
* JS API * `JS API`
* Canvas * `Canvas`
* Other * `DOM`
* DOM * `Other`
* "stats" The collection of support data for a given set of browsers/versions. Only the support value strings can be modified. Values are space-separated characters with these meanings: * **stats** The collection of support data for a given set of browsers/versions. Only the support value strings can be modified. Values are space-separated characters with these meanings:
* y - (Y)es, supported * `y` - (**Y**)es, supported
* a - (A)lmost supported (aka Partial support) * `a` - (**A**)lmost supported (aka Partial support)
* n - (N)o support * `n` - (**N**)o support
* p - No support, but has (P)olyfill * `p` - No support, but has (**P**)olyfill
* u - Support (u)nknown * `u` - Support (**u**)nknown
* x - Requires prefi(x) to work * `x` - Requires prefi(**x**) to work
* "notes" Notes on feature support, often to explain what partial support refers to * **notes** Notes on feature support, often to explain what partial support refers to
* "ucprefix" Prefix should start with an uppercase letter * **ucprefix** Prefix should start with an uppercase letter
* "parent" ID of parent feature * **parent** ID of parent feature
* "keywords" Comma separated words that will match the feature in a search * **keywords** Comma separated words that will match the feature in a search
* "shown" Whether or not feature is ready to be shown on the site. This can be left as false if the support data or information for other fields is still being collected * **shown** Whether or not feature is ready to be shown on the site. This can be left as false if the support data or information for other fields is still being collected


## Adding a feature ## Adding a feature


Expand All @@ -55,5 +60,5 @@ Currently it is not possible to:
* Add a new browser or browser version (this will be made possible later) * Add a new browser or browser version (this will be made possible later)
* Add a test for any given feature (should also come later) * Add a test for any given feature (should also come later)
* Add any object properties not already defined above * Add any object properties not already defined above
* Modify the "usage\_perc\_y" or "usage\_perc\_a" values (these values are generated) * Modify the **usage\_perc\_y** or **usage\_perc\_a** values (these values are generated)


0 comments on commit 029d4c3

Please sign in to comment.