-
Notifications
You must be signed in to change notification settings - Fork 616
docs: add versioning guide #3462
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 📦
|
contributor-docs/versioning.md
Outdated
|
||
semver bump: **minor** | ||
|
||
When a type is broadeded, it is now possible for that type to include both the |
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.
broadeded
Typo?
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.
Hah, great catch 😂
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.
🔥
How can we make sure this doc becomes a living document as we discover cases/examples in release rotations or in general really?
Would it be helpful to add this to the release conductor checklist like an optional one maybe but encouraged? 🤔
| | [The type of a prop is broadened](#the-type-of-a-prop-is-broadened) | `minor` | | ||
| | [The type of a prop is narrowed](#the-type-of-a-prop-is-narrowed) | `major` | |
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 these so much! 💖
This is a follow-up to: #2753 with a narrowed scope of changes that I believe we have consensus on with respect to semver 👀 Figured it'd be useful to get this document into
contributor-docs
and add to it over time as we run into things in our release process.Would love to know what you all think of this format and if there is anything that should be added, edited, or if there is a better approach to documenting these kinds of conventions so that we can refer to them in reviews and in our release process.