celo-org / celo-org/celo-token-list

Consider adding changeset or instructions to manually bump package version

Open
#54 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
6
Forks
15
PR merge metrics
No merged PRs in 30d

Description

## Description

Seems like we suggested to bump the package by a minor version when a token is added.

For example, PRs that added tokens and:

- bumped the minor version
- https://github.com/celo-org/celo-token-list/pull/39
- https://github.com/celo-org/celo-token-list/pull/53
- didn't bump the minor version
- https://github.com/celo-org/celo-token-list/pull/47

It might make sense to add `changeset` so we have a CHANGELOG of tokens that were added, and a simple way for people to bump the appropriate version.

We should also explain that adding a token is a minor version and can be done using changeset (either using the changeset comment in the Github UI, or using `yarn run changeset` locally).

From [Uniswap/token-lists](https://github.com/Uniswap/token-lists?tab=readme-ov-file#semantic-versioning):

> Lists include a `version` field, which follows [semantic versioning](https://semver.org/).
>
> List versions must follow the rules:
>
> - Increment major version when tokens are removed
> - Increment minor version when tokens are added
> - Increment patch version when tokens already on the list have minor details changed (name, symbol, logo URL, decimals)
>
> Changing a token address or chain ID is considered both a remove and an add, and should be a major version update.
>
> Note that list versioning is used to improve the user experience, but not for security, i.e. list versions are not meant
> to provide protection against malicious updates to a token list; i.e. the list semver is used as a lossy compression
> of the diff of list updates. List updates may still be diffed in the client dApp.

## Other

This was inspired by this comment which made me aware that versions should be bumped. I couldn't see any instructions for this in the repo.

> @aspiers would you mind bumping up the package version as per [the example commit](https://github.com/celo-org/celo-token-list/commit/3b9d9182c4af66c4a91c6561f9a8fa103015487b)?

_Originally posted by @shazarre in https://github.com/celo-org/celo-token-list/issues/53#issuecomment-2011945118_

Contributor guide

Open the contributing guide

Research direction

Review the repository's current package-version and release setup first; no specific file is identified in the issue. Evaluate adding Changesets and documenting the `yarn run changeset` workflow, with done defined as consistent semver guidance for token additions and a changelog/versioning path.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.