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

Decide on & document stable vs. experimental properties of the LHR #2668

Closed
patrickhulce opened this issue Jul 10, 2017 · 2 comments
Closed

Comments

@patrickhulce
Copy link
Collaborator

Currently audits need to maintain certain properties of their return object for backwards compatibility in DevTools/viewer (details, name, description, etc). However, it's not clear to external consumers what properties are safe to use within a major version and which are not (e.g. we almost removed all of extendedInfo in a patch version bump which people were likely using from previous versions).

We should decide and document which properties we're committed to keeping until v3 and make it easier to confidently consume LH results.

@brendankenny
Copy link
Member

this would go well with whatever docs generator we come up with for #2463 :)

@paulirish paulirish changed the title Decide on and document stable vs. experimental properties of JSON results Decide on & document stable vs. experimental properties of the LHR Oct 12, 2017
@patrickhulce
Copy link
Collaborator Author

Mostly done by #3495, future work might be reworking the extendedInfo to be more stable.

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

No branches or pull requests

2 participants