search

celo-org / celo-token-list

Celo's default token list
https://celo-org.github.io/celo-token-list/celo.tokenlist.json
3 stars 5 forks source link

Consider adding changeset or instructions to manually bump package version #54

Open arthurgousset opened 4 months ago

arthurgousset commented 4 months ago

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:

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:

Lists include a version field, which follows semantic versioning.

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?

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