cowprotocol / cowprotocol/token-lists

Major version bump when token address changes

Open
#47 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
16
Forks
35
PR merge metrics
No merged PRs in 30d

Description

Summary

We must make sure to do a MAJOR version bump when any token address in the list changes

See this PR for reference https://github.com/cowprotocol/token-lists/pull/46

Add a linter and/or a GH action step to prevent merges/deployments in that case

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR #46 and the token address list and versioning flow it changed. Determine where a linter or GitHub Actions check can compare token addresses between versions. Done means merges or deployments are prevented when an address changes without a MAJOR version bump.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.