Update changeset guidelines #4510

AdrianContiu · 2024-08-27T07:38:10Z

[FX-NNNN]

Description

Update changeset guidelines to include a reference to '@toptal/picasso': patch for major bumps.

How to test

Temploy
FIXME: Add the steps describing how to verify your changes

Screenshots

Before.	After.

All development checks should be done and set checked to pass the
GitHub Bot: TODOLess action

PR commands

List of available commands:

@toptal-bot run package:alpha-release - Release alpha version
@toptal-anvil ping reviewers - Ping FX team for review

PR Review Guidelines

When to approve? ✅

You are OK with merging this PR and

You have no extra requests.
You have optional requests.
1. Add nit: to your comment. (ex. nit: I'd rename this variable from makeCircle to getCircle)

When to request changes? ❌

You are not OK with merging this PR because

Something is broken after the changes.
Acceptance criteria is not reached.
Code is dirty.

When to comment (neither ✅ nor ❌)

You want your comments to be addressed before merging this PR in cases like:

There are leftovers like unnecessary logs, comments, etc.
You have an opinionated comment regarding the code that requires a discussion.
You have questions.

How to handle the comments?

An owner of a comment is the only one who can resolve it.
An owner of a comment must resolve it when it's addressed.
A PR owner must reply with ✅ when a comment is addressed.

changeset-bot · 2024-08-27T07:38:14Z

⚠️ No Changeset found

Latest commit: 465c9a6

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

AdrianContiu · 2024-08-27T07:42:38Z

@toptal-anvil ping reviewers

dmaklygin · 2024-08-27T07:48:25Z

docs/contribution/changeset-guidelines.md

@@ -32,6 +32,8 @@ Please use this format:
 ```
 ---
 '@toptal/[package]': [version bump]
+//if the build bump is major, please also add the line below to have the changeset comments visible in the Picasso patch release notes.
+'@toptal/picasso': patch 


I'm afraid this comment will always be visible

That's correct! :)
I've changed it, Thx!

If the https://github.com/toptal/picasso/blob/master/packages/topkit-analytics-charts/package.json is bumped, we do not need to bump @toptal/picasso as it does not depend on it. Should there be some kind of specification that @toptal/picasso should be bumped not in 100% if cases (as @toptal/picasso does not depend on all packages in https://github.com/toptal/picasso)

Let's also mention, that when we add the patch for Picasso, we should also include the heading for giving context in the Picasso release notes

AdrianContiu · 2024-09-05T12:20:50Z

@toptal-anvil ping reviewers

dmaklygin · 2024-09-05T12:37:28Z

docs/contribution/changeset-guidelines.md

@@ -32,6 +32,7 @@ Please use this format:
 ```
 ---
 '@toptal/[package]': [version bump]
+//if the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that depend on picasso, usually of the form `@toptal/picasso-show-more`.


I didn't get this: packages that depend on picasso — maybe we are talking about packages that Picasso depends on?

You are right! I will reformulate accordingly! Thx!

When introducing changes to Picasso, it's important to distinguish between updates that require user action and those that don't.

For example, in the case of a Tailwind migration, since Picasso already includes a peer dependency on picasso-tailwind, users don't need to take any additional steps when new components are migrated. Therefore, such changes can be considered non-breaking, and a patch update would suffice.

However, for breaking changes—such as an API modification (e.g., removing the icon property from the List component)—these changes would require users to adjust their implementations. In these cases, a major version bump for Picasso is necessary, rather than a patch.

OleksandrNechai · 2024-09-06T12:21:03Z

docs/contribution/changeset-guidelines.md

@@ -32,6 +32,7 @@ Please use this format:
 ```
 ---
 '@toptal/[package]': [version bump]
+//if the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.


Suggested change

//if the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.

// if the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.

AdrianContiu · 2024-10-08T09:06:05Z

@toptal-anvil ping reviewers

sashuk · 2024-10-08T09:16:35Z

docs/contribution/changeset-guidelines.md

@@ -29,6 +29,9 @@ The same as commits, we write changeset in `present simple`.

 Please use this format:

+> [!NOTE]
+> If the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.


NIT

Suggested change

> If the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.

> If the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is required for packages that Picasso depends on, usually these packages have name like `@toptal/picasso-package-name`.

sashuk

Added small NIT comment, overall looks good!

docs/contribution/changeset-guidelines.md

OleksandrNechai · 2024-10-08T18:00:16Z

docs/contribution/changeset-guidelines.md

@@ -29,6 +29,9 @@ The same as commits, we write changeset in `present simple`.

 Please use this format:

+> [!NOTE]
+> If the version bump is major, please also add `'@toptal/picasso': patch | minor | major` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is required for packages that Picasso depends on, usually these packages have name like `@toptal/picasso-package-name`.
+


Unfortunately I could not understand this note.

Maybe better to put it after the format itself? The text earlier says "Please use this format:" and then note comes as if it is format 🤔

version bump is major, please also add '@toptal/picasso': patch | minor | major` does not make sense to me. Add where? How do I pick between patch | minor | major?

don't forget to include the heading include where? what heading?

Picasso patch release notes could be a link.

usually these packages have name like how do I know if I am in unusual case? What if my package is called differently but Picasso depends on it? How do I know?

General note. This is technical documentation, IMO it has to be very terse and clear, without "please" and "don't forget". Here is and example I did with ChatGPT:

For major version bumps, add '@toptal/picasso': patch | minor | major and include the heading to display the changeset comments in the Picasso patch release notes. This applies to Picasso dependent packages, typically named @toptal/picasso-package-name.

OleksandrNechai

Thanks for improving documentation! I think it is good overall, but I think there is room for improvement. Please, make the text more clear and in tech docs style and we will be good to go ;)

AdrianContiu added 2 commits August 27, 2024 10:28

Update changeset file

51c05d9

Fix typo

ab59e5a

AdrianContiu added the no-jira label Aug 27, 2024

AdrianContiu self-assigned this Aug 27, 2024

AdrianContiu marked this pull request as ready for review August 27, 2024 07:42

AdrianContiu requested a review from a team August 27, 2024 07:42

dmaklygin reviewed Aug 27, 2024

View reviewed changes

Fix message structure

6c212c1

AdrianContiu requested a review from dmaklygin August 27, 2024 09:00

AdrianContiu added 2 commits September 5, 2024 15:18

Update changeset guidelines

14b3a2e

Merge 'master' in upd-changeset-guidelines

86d10c7

dmaklygin reviewed Sep 5, 2024

View reviewed changes

Reformulate the changeset message

e73a2f7

TomasSlama mentioned this pull request Sep 6, 2024

[FX-4717] Delete icon property #4530

Merged

4 tasks

OleksandrNechai reviewed Sep 6, 2024

View reviewed changes

AdrianContiu added 2 commits October 7, 2024 11:08

Insert note icon

93d8aa0

Merge 'master' in upd-changeset-guidelines

6d96d3c

AdrianContiu requested review from sashuk, OleksandrNechai, TomasSlama and dmaklygin October 8, 2024 06:38

sashuk reviewed Oct 8, 2024

View reviewed changes

sashuk approved these changes Oct 8, 2024

View reviewed changes

TomasSlama reviewed Oct 8, 2024

View reviewed changes

docs/contribution/changeset-guidelines.md Outdated Show resolved Hide resolved

AdrianContiu added 2 commits October 8, 2024 16:52

Address review comments

bf7019f

Merge 'master' in upd-changeset-guidelines

465c9a6

AdrianContiu requested a review from TomasSlama October 8, 2024 13:55

TomasSlama approved these changes Oct 8, 2024

View reviewed changes

OleksandrNechai reviewed Oct 8, 2024

View reviewed changes

OleksandrNechai requested changes Oct 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update changeset guidelines #4510

Update changeset guidelines #4510

AdrianContiu commented Aug 27, 2024 •

edited

Loading

changeset-bot bot commented Aug 27, 2024 •

edited

Loading

AdrianContiu commented Aug 27, 2024

dmaklygin Aug 27, 2024

AdrianContiu Aug 27, 2024

sashuk Aug 27, 2024

TomasSlama Sep 3, 2024

AdrianContiu commented Sep 5, 2024

dmaklygin Sep 5, 2024

AdrianContiu Sep 5, 2024

TomasSlama Sep 6, 2024

OleksandrNechai Sep 6, 2024

AdrianContiu commented Oct 8, 2024

sashuk Oct 8, 2024

sashuk left a comment

OleksandrNechai Oct 8, 2024 •

edited

Loading

OleksandrNechai left a comment

	//if the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.
	// if the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.

	> If the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is only required for packages that Picasso depends on, usually of the form `@toptal/picasso-package-name`.
	> If the version bump is major, please also add `'@toptal/picasso': patch` and don't forget to include the heading to have the changeset comments visible in the Picasso patch release notes. This is required for packages that Picasso depends on, usually these packages have name like `@toptal/picasso-package-name`.

Update changeset guidelines #4510

Are you sure you want to change the base?

Update changeset guidelines #4510

Conversation

AdrianContiu commented Aug 27, 2024 • edited Loading

Description

How to test

Screenshots

When to approve? ✅

When to request changes? ❌

When to comment (neither ✅ nor ❌)

How to handle the comments?

changeset-bot bot commented Aug 27, 2024 • edited Loading

⚠️ No Changeset found

AdrianContiu commented Aug 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdrianContiu commented Sep 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdrianContiu commented Oct 8, 2024

Choose a reason for hiding this comment

sashuk left a comment

Choose a reason for hiding this comment

OleksandrNechai Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

OleksandrNechai left a comment

Choose a reason for hiding this comment

AdrianContiu commented Aug 27, 2024 •

edited

Loading

changeset-bot bot commented Aug 27, 2024 •

edited

Loading

OleksandrNechai Oct 8, 2024 •

edited

Loading