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.

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

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

Open
arthurgousset opened this issue Mar 27, 2024 · 0 comments

Comments

@arthurgousset
Copy link
Contributor

arthurgousset commented Mar 27, 2024

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 #53 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant