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.

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

OWD project: clean up BCD data guidelines #69

Closed
2 of 3 tasks
ddbeck opened this issue Sep 29, 2021 · 2 comments · Fixed by mdn/browser-compat-data#17519
Closed
2 of 3 tasks

OWD project: clean up BCD data guidelines #69

ddbeck opened this issue Sep 29, 2021 · 2 comments · Fixed by mdn/browser-compat-data#17519

Comments

@ddbeck
Copy link
Contributor

ddbeck commented Sep 29, 2021

Summary: To maintain the high quality of BCD data (which appears in compat tables and caniuse), we have conventions for recording certain data. Some of those conventions have been recently established, but were never written down, leading to a risk that that data will not be maintained properly. This proposal addresses that risk.

Recent efforts have caused BCD's data guidelines to slip out of sync with our actual practices. I'd like to propose a (hopefully small) effort to bring the data guidelines back in sync.

Some of these tasks have been nominally claimed by people who participated in them (e.g., sideshowbarker for spec_urls and foolip for globals). Perhaps they still want to work on them and might benefit from having a designated reviewer, or perhaps they'd like to hand off the task to some else.

I'd also be willing to be a reviewer, to support any or all of this work.

Tasks:

  • Write (or review) a data guideline for how to choose a spec URL (e.g., which spec and URL fragment) (i.e., document the completed spec URL work
  • Write (or review) a data guideline for how to record globals (e.g., when to put an API in __globals) (i.e., document Move WindowOrWorkerGlobalScope features to api.* (_globals folder) mdn/browser-compat-data#11518)
  • Improve navigation of data guidelines (e.g., add more headings to group related guidelines and put the guidelines into some sort of meaningful order)
@Elchi3
Copy link
Member

Elchi3 commented Aug 23, 2022

Write (or review) a data guideline for how to choose a spec URL (e.g., which spec and URL fragment) (i.e., document the completed spec URL work

This got done?

@queengooborg
Copy link
Member

I forgot that the spec URL documentation was a part of this -- let's split it off into its own project as it seems to be more like guideline "addition" instead of "cleanup"! (Also because I don't feel that I know enough about spec URLs to write up a guideline for them... ;P)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants