Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update changeset guidelines #4510

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Update changeset guidelines #4510

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
51c05d9
Update changeset file
AdrianContiu Aug 27, 2024
ab59e5a
Fix typo
AdrianContiu Aug 27, 2024
6c212c1
Fix message structure
AdrianContiu Aug 27, 2024
14b3a2e
Update changeset guidelines
AdrianContiu Sep 5, 2024
86d10c7
Merge 'master' in upd-changeset-guidelines
AdrianContiu Sep 5, 2024
e73a2f7
Reformulate the changeset message
AdrianContiu Sep 5, 2024
93d8aa0
Insert note icon
AdrianContiu Oct 7, 2024
6d96d3c
Merge 'master' in upd-changeset-guidelines
AdrianContiu Oct 7, 2024
bf7019f
Address review comments
AdrianContiu Oct 8, 2024
465c9a6
Merge 'master' in upd-changeset-guidelines
AdrianContiu Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/contribution/changeset-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Copy link
Collaborator

@OleksandrNechai OleksandrNechai Oct 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Unfortunately I could not understand this note.

  1. 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 🤔
  2. 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?
  3. don't forget to include the heading include where? what heading?
  4. Picasso patch release notes could be a link.
  5. 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.

```
---
'@toptal/[package]': [version bump]
Expand Down
Loading