Document a public API and SemVer policy #7615
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
docs
Elchi3
requested changes
Dec 8, 2020
Co-authored-by: Michael[tm] Smith <[email protected]>
|
Thanks for the eagle-eyed copy edits, @sideshowbarker! @Elchi3 I've expanded the list for WebExtensions. Good catch! |
sideshowbarker
approved these changes
Dec 9, 2020
|
@jpmedley You asked to have a look at this during the editorial meeting. Since I plan to follow this policy for today's release (which will be a semver major release), I plan to merge this before the release today (probably around 8-10am PST). If you don't get a chance to look at this before I merge, I'd still like your feedback. Thank you! |
|
It looks fine to me. I should have been clear that I wasn't interested in giving feedback. I was interested in possible consequences to a tool that I built that consumes this data. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This recasts the list of data folders as the public API for
@mdn/browser-compat-dataand explicitly names it as such for the purposes of a semantic versioning policy. This fixes #7563.The diff here is a bit ugly. You may want to use the split or rich diffs to review this one. You can also view the full README rendered on my fork.