Skip to content

docs: add versioning guide - #3462

Merged
joshblack merged 2 commits into
mainfrom
docs/add-versioning-docs-take-2
Jul 3, 2023
Merged

docs: add versioning guide#3462
joshblack merged 2 commits into
mainfrom
docs/add-versioning-docs-take-2

Conversation

@joshblack

@joshblackjoshblack commented Jun 29, 2023

Copy link
Copy Markdown
Member

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.

@joshblack
joshblack requested review from a team and broccolinisoupJune 29, 2023 15:20
@changeset-bot

changeset-botBot commented Jun 29, 2023•
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a0eb612

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@joshblackjoshblack added the skip changeset This change does not need a changelog label Jun 29, 2023
@github-actions

github-actionsBot commented Jun 29, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
dist/browser.esm.js101.95 KB (0%)
dist/browser.umd.js102.5 KB (0%)

@joshblack
joshblack temporarily deployed to github-pages June 29, 2023 15:26 — with GitHub Actions Inactive
@github-actions
github-actionsBot temporarily deployed to storybook-preview-3462 June 29, 2023 15:27 Inactive
lesliecdubs
lesliecdubs reviewed Jun 29, 2023
View reviewed changes
Comment threadcontributor-docs/versioning.md Outdated

semver bump: **minor**

When a type is broadeded, it is now possible for that type to include both the

@lesliecdubslesliecdubsJun 29, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

broadeded

Typo?

@joshblackjoshblackJun 29, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hah, great catch 😂

@github-actions
github-actionsBottemporarily deployed to storybook-preview-3462 June 29, 2023 15:51 Inactive
broccolinisoup
broccolinisoup approved these changes Jun 30, 2023
View reviewed changes

@broccolinisoupbroccolinisoup left a comment

Copy link
Copy Markdown
Member

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? 🤔

Comment threadcontributor-docs/versioning.md
Comment on lines +48 to +49
| | [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` |

@broccolinisoupbroccolinisoupJun 30, 2023

Copy link
Copy Markdown
Member

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! 💖

@joshblack
joshblack added this pull request to the merge queueJul 3, 2023
Merged via the queue into main with commit b3462b1Jul 3, 2023
@joshblack
joshblack deleted the docs/add-versioning-docs-take-2 branch July 3, 2023 14:50
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lesliecdubslesliecdubslesliecdubs left review comments
@broccolinisoupbroccolinisoupbroccolinisoup approved these changes

Assignees

No one assigned

Labels

skip changesetThis change does not need a changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@joshblack@broccolinisoup@lesliecdubs