Skip to content
This repository
Newer
Older
100644 65 lines (54 sloc) 2.881 kb
6091ce54 »
2012-09-16 data update with new contributable feature files
1 # Contributing to the caniuse data
2
029d4c35 »
2012-10-03 rephrase 2nd sentence + various formatting tweaks
3 The features-json directory includes JSON files for every feature found on the caniuse.com website.
4 Maintaining these files on GitHub allows anyone to update or contribute to the support data on the site.
6091ce54 »
2012-09-16 data update with new contributable feature files
5
6 ## How it works
7
029d4c35 »
2012-10-03 rephrase 2nd sentence + various formatting tweaks
8 The data on the site is stored in a database.
9 This data is periodically exported to the JSON files on GitHub.
10 Once a change or new file here has been approved, it is integrated back into the database
11 and the subsequent export files should be the same as the imported ones.
12 Not too confusing, I hope. :)
6091ce54 »
2012-09-16 data update with new contributable feature files
13
14 ## Supported changes
15
16 Currently the following feature information can be modified:
029d4c35 »
2012-10-03 rephrase 2nd sentence + various formatting tweaks
17 * **title** — Feature name (used for the title of the table)
18 * **description** — Brief description of feature
19 * **spec** — Spec URL
20 * **status** — Spec status, one of the following:
21 * `rec` - W3C Recommendation
22 * `pr` - W3C Proposed Recommendation
23 * `cr` - W3C Candidate Recommendation
24 * `wd` - W3C Working Draft
25 * `other` - Non-W3C, but reputable
26 * `unoff` - Unofficial or W3C "Note"
27 * **links** — Array of "link" objects consisting of URL and short description of link
28 * **bugs** — Array of "bug" objects consisting of a bug description
29 * **categories** — Array of categories, any of the following:
30 * `HTML5`
31 * `CSS`
32 * `CSS2`
33 * `CSS3`
34 * `SVG`
35 * `PNG`
36 * `JS API`
37 * `Canvas`
38 * `DOM`
39 * `Other`
40 * **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:
41 * `y` - (**Y**)es, supported
42 * `a` - (**A**)lmost supported (aka Partial support)
43 * `n` - (**N**)o support
44 * `p` - No support, but has (**P**)olyfill
45 * `u` - Support (**u**)nknown
46 * `x` - Requires prefi(**x**) to work
47 * **notes** — Notes on feature support, often to explain what partial support refers to
48 * **ucprefix** — Prefix should start with an uppercase letter
49 * **parent** — ID of parent feature
50 * **keywords** — Comma separated words that will match the feature in a search
51 * **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
6091ce54 »
2012-09-16 data update with new contributable feature files
52
53 ## Adding a feature
54
55 To add a feature, simply add another JSON file to the directory with the base file name as the feature ID (only alphanumeric characters and hyphens please). If you want to submit a feature but don't have all information available for it yet, make sure you set the "shown" flag to false.
56
57 ## Unsupported changes
58
59 Currently it is not possible to:
60 * Add a new browser or browser version (this will be made possible later)
61 * Add a test for any given feature (should also come later)
62 * Add any object properties not already defined above
029d4c35 »
2012-10-03 rephrase 2nd sentence + various formatting tweaks
63 * Modify the **usage\_perc\_y** or **usage\_perc\_a** values (these values are generated)
6091ce54 »
2012-09-16 data update with new contributable feature files
64
Something went wrong with that request. Please try again.