-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
implement AbstractFlashcardViewer / Javascript API versioning #6328
Comments
To be more clear:
Concrete example of the versioning point: You propose a PR that adds something the JS/WebView interface? That's a minor version bump in the API. (from 1.0.0 to 1.1.0) You propose a PR that reorganizes the API completely or alters how the API reacts to the same inputs (a breaking change)? Major version bump: 1.0.0 becomes 2.0.0 - these should be done only when absolutely necessary. All effort should be made to be backwards-compatible instead via deprecation, ideally with warning in the Reviewer for users of the old API that there is a major version change coming that alters behavior they rely on, if they use the deprecated features You propose a PR that just fixes a bug? patch version: 1.0.0 becomes 1.0.1 |
Hello 👋, this issue has been opened for more than 2 months with no activity on it. If the issue is still here, please keep in mind that we need community support and help to fix it! Just comment something like still searching for solutions and if you found one, please open a pull request! You have 7 days until this gets closed automatically |
Hello bot, api is in progress. |
Totally in progress and close I think! I was just on vacation but am getting back at it, I know this one is nearly ready but I haven't had time to review (sorry!) |
Reproduction Steps
Expected Result
Some indication that your card template isn't working correctly, and that there is a real reason, and ideally who to contact and maybe how to fix it yourself
Actual Result
Card might just break, no idea why
From @david-allison-1 in #6307 (review) I liked this idea a lot:
So perhaps something like:
Or similar, I'm more vague on the last points, anything reasonable to do versioning with user / developer notification of changes and ability to self help is welcome
The text was updated successfully, but these errors were encountered: