-
Notifications
You must be signed in to change notification settings - Fork 647
docs(versioning): update docs to include landmark roles #3743
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
Conversation
|
size-limit report 📦
|
broccolinisoup
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I love this 🔥 My only feedback/question is that should we elaborate what we mean by "potentially major" under the semver section? 👀
TylerJDev
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! ✨
Off-topic, but it might be worth a discussion in the future to see if we should steer clear from having default landmarks all together in components and always give that choice to the consumer? This doesn't seem to be the norm in newer components, but I do see the friction that could be caused through updates such as with PageLayout and others. I really like the approach done in the fix #3737 and I wonder if it could be applied elsewhere 🤔
iansan5653
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, thank you!
|
@TylerJDev totally agreed, I think you're dead-on that we probably shouldn't be baking in default landmark roles. Let me see where would a good place be to capture that so that we consider it in future component work 👀 (or let me know if you have any places in mind where it may be good to capture this!) |
Add a section to our versioning docs to include landmark roles as they relate to semver.
Feedback
Would love to hear what you all think about this section and if it accurately captures our semver policy 👀 Let me know if there is anything missing or anything that needs to be changed!