Skip to content

rephrase 2nd sentence + various formatting tweaks #9

Merged
merged 1 commit into from Oct 3, 2012
+43 −38
View
81 Contributing.md
@@ -1,49 +1,54 @@
# 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
-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
Currently the following feature information can be modified:
-* "title" Feature title
-* "description" Brief description of feature
-* "spec" Spec URL
-* "status" Spec status, one of the following:
- * rec (W3C Recommendation)
- * pr (W3C Proposed Recommendation)
- * cr (W3C Candidate Recommendation)
- * wd (W3C Working Draft)
- * other (Non-W3C, but reputable)
- * unoff (Unofficial or W3C "Note")
-* "links" Array of "link" objects consisting of URL and short description of link
-* "bugs" Array of "bug" objects consisting of a bug description
-* "categories" Array of categories, any of the following:
- * HTML5
- * CSS
- * CSS2
- * CSS3
- * SVG
- * PNG
- * JS API
- * Canvas
- * Other
- * DOM
-* "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
- * a - (A)lmost supported (aka Partial support)
- * n - (N)o support
- * p - No support, but has (P)olyfill
- * u - Support (u)nknown
- * x - Requires prefi(x) to work
-* "notes" Notes on feature support, often to explain what partial support refers to
-* "ucprefix" Prefix should start with an uppercase letter
-* "parent" ID of parent feature
-* "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
+* **title**Feature name (used for the title of the table)
+* **description** Brief description of feature
+* **spec** Spec URL
+* **status** Spec status, one of the following:
+ * `rec` - W3C Recommendation
+ * `pr` - W3C Proposed Recommendation
+ * `cr` - W3C Candidate Recommendation
+ * `wd` - W3C Working Draft
+ * `other` - Non-W3C, but reputable
+ * `unoff` - Unofficial or W3C "Note"
+* **links** Array of "link" objects consisting of URL and short description of link
+* **bugs** Array of "bug" objects consisting of a bug description
+* **categories** Array of categories, any of the following:
+ * `HTML5`
+ * `CSS`
+ * `CSS2`
+ * `CSS3`
+ * `SVG`
+ * `PNG`
+ * `JS API`
+ * `Canvas`
+ * `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:
+ * `y` - (**Y**)es, supported
+ * `a` - (**A**)lmost supported (aka Partial support)
+ * `n` - (**N**)o support
+ * `p` - No support, but has (**P**)olyfill
+ * `u` - Support (**u**)nknown
+ * `x` - Requires prefi(**x**) to work
+* **notes** Notes on feature support, often to explain what partial support refers to
+* **ucprefix** Prefix should start with an uppercase letter
+* **parent** ID of parent feature
+* **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
## Adding a feature
@@ -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 test for any given feature (should also come later)
* 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)
Something went wrong with that request. Please try again.