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

doc: Improve the contribution documentation #201

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

jlwllmr
Copy link

@jlwllmr jlwllmr commented Feb 11, 2025

Action: add / update / remove token (keep those that applies) Update README to provide better instructions for contributors
Context / rational: The existing README lacks proper detail about the difference between the shortlist and the full list. This PR makes it a bit clearer and also ensures the guidelines are pointed out more clearly, which is important as these are mandatory. Also adds a few formatting improvements.

Also removes the Goerli shortlist that still existed, since the Goerli testnet has been unavailable for some time now.

PR checklist:

  • I've verified and published the contract source
  • I've kept the token list in alphabetical order based on token symbol
  • I've updated the updatedAt (and potentially createdAt) fields
  • I've updated the list version number as per README instruction

arthur-remy
arthur-remy previously approved these changes Feb 11, 2025
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@alainncls
Copy link
Collaborator

We should probably remove the Goerli list once and for all.

alainncls
alainncls previously approved these changes Feb 11, 2025
@alainncls alainncls changed the title Update README doc: Improve the contribution documentation Feb 12, 2025
@alainncls alainncls self-requested a review February 12, 2025 15:08
alainncls
alainncls previously approved these changes Feb 12, 2025
README.md Outdated Show resolved Hide resolved
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

Successfully merging this pull request may close these issues.

4 participants