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

Update CONTRIBUTING.md with details what versions of browsers should be used etc. #2620

Closed
jakub-g opened this issue Aug 17, 2018 · 1 comment · Fixed by #3915
Closed

Update CONTRIBUTING.md with details what versions of browsers should be used etc. #2620

jakub-g opened this issue Aug 17, 2018 · 1 comment · Fixed by #3915
Assignees
Labels
docs Issues or pull requests regarding the documentation of this project.

Comments

@jakub-g
Copy link
Contributor

jakub-g commented Aug 17, 2018

It would be good IMO to document in CONTRIBUTING.md what versions are expected to be provided in the compat data

  • Edge shows two versions when you go to its Settings screen, the browser itself like Microsoft Edge 42.17134.1.0 and the engine version like Microsoft EdgeHTML 17.17134. It seems that the latter is used on MDN (Edge 17)
  • When it comes to mobile Safari, should the version of Safari or version of iOS be provided? This is not clear (they are not always in sync, for example Safari 11.1 is shipped in iOS 11.3 -> seems that Safari version is used
  • Whether versions of Safari should be like 11.0 or 11 -> seems that 11 format is used

(Also on MDN itself, maybe when you hover over those browsers, it should say which version are we talking about).

WDYT?

@jakub-g jakub-g changed the title Update CONTRIBUTING.md with details what versions of browsers should be used Update CONTRIBUTING.md with details what versions of browsers should be used etc. Aug 24, 2018
@Elchi3 Elchi3 added the docs Issues or pull requests regarding the documentation of this project. label Aug 24, 2018
This was referenced Oct 4, 2018
@queengooborg queengooborg self-assigned this Apr 17, 2019
@queengooborg
Copy link
Contributor

queengooborg commented Apr 17, 2019

You've brought up some really good points, and these parts can come off as confusing. I'll start tackling this one!

Edge shows two versions when you go to its Settings screen, the browser itself like Microsoft Edge 42.17134.1.0 and the engine version like Microsoft EdgeHTML 17.17134. It seems that the latter is used on MDN (Edge 17)

This, I intend to resolve in #3166.

When it comes to mobile Safari, should the version of Safari or version of iOS be provided? This is not clear (they are not always in sync, for example Safari 11.1 is shipped in iOS 11.3 -> seems that Safari version is used

We've been using the Safari versions, but Apple states that it should be the iOS version.

Whether versions of Safari should be like 11.0 or 11 -> seems that 11 format is used

This is correct, and should definitely be addressed in the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues or pull requests regarding the documentation of this project.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants