Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add data guideline regarding constants #8062

Merged
merged 4 commits into from
Jan 7, 2021
+9 −0
Merged

Add data guideline regarding constants #8062

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a954b9
Add data guideline regarding constants
sideshowbarker Dec 20, 2020
496a16c
Update docs/data-guidelines.md
sideshowbarker Jan 4, 2021
bcfd5fc
Give example constant that we don’t include
sideshowbarker Jan 4, 2021
872c67f
Update ToC
sideshowbarker Jan 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/data-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This file contains recommendations to help you record data in a consistent and u
- [`"partial_implementation"` requires a note](#partial_implementation-requires-a-note)
- [Non-functional defined names imply `"partial_implementation"`](#non-functional-defined-names-imply-partial_implementation)
- [Operating system limitations imply `"partial_implementation"`](#operating-system-limitations-imply-partial_implementation)
- [Constants](#constants)
- [Release lines and backported features](#release-lines-and-backported-features)
- [Safari for iOS versioning](#safari-for-ios-versioning)
- [Addition of browsers](#addition-of-browsers)
Expand Down Expand Up @@ -177,6 +178,14 @@ However, this guideline does not apply to features where the browser's expected

This guideline was proposed in [#6906](https://github.com/mdn/browser-compat-data/issues/6906).

## Constants

Don't include data for constants in BCD. The rationale for not including them is that they're not known to be a source of any compatibility issues.

For example, although the UI Events specification defines a [`DOM_KEY_LOCATION_STANDARD`](https://w3c.github.io/uievents/#dom-keyboardevent-dom_key_location_standard) constant, we don't include data for it in BCD.

This guideline was proposed in [#7936](https://github.com/mdn/browser-compat-data/issues/7585), based in part on previous discussion in [#7585](https://github.com/mdn/browser-compat-data/issues/7585).

## Release lines and backported features

Use version numbers to reflect which _release line_ (major or minor but not patch-level releases) first supported a feature, rather than absolute version numbers.
Expand Down