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
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/verify-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:

- name: Validate JSON
run: |
jsonschema -i ./json/linea-goerli-token-shortlist.json ./json/schema/l2-token-list-schema.json
jsonschema -i ./json/linea-sepolia-token-shortlist.json ./json/schema/l2-token-list-schema.json

verify_mainnet_shortlist:
runs-on: ubuntu-latest
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ If you want to add a token or validate an addition, please follow the procedures
If you represent a project with a token on Linea, it's beneficial to add it to the shortlist. Tokens on this list are reflected in the UI of the Linea canonical bridge.

> [!IMPORTANT]
> Before adding a new token, you must verify the token's smart contract. This ensures the authenticity and security of the token. Contract verification should be done through [LineaScan's](https://lineascan.build/) or [Etherscan's](https://etherscan.io/) contract verification tools.
> Before adding a new token, you must verify the token's smart contract on an explorer. This ensures the authenticity and security of the token. Contract verification should be done through [LineaScan's](https://lineascan.build/verifyContract) or via Hardhat's plugin ([`hardhat-verify`](https://hardhat.org/hardhat-runner/plugins/nomicfoundation-hardhat-verify)).
jlwllmr marked this conversation as resolved.
Show resolved Hide resolved
> The same verification should be done on Ethereum L1 and Linea if necessary.

To add a new token:

Expand All @@ -28,7 +29,7 @@ cd linea-token-list
git checkout -b feat/<token-name>
```

2. Fill out the [./json/linea-goerli-token-shortlist.json](./json/linea-mainnet-token-shortlist.json) with your token's information. Make sure you adhere to the [guidelines](#guidelines).
2. Fill out the [linea-mainnet-token-shortlist.json](./json/linea-mainnet-token-shortlist.json) with your token's information. Make sure you adhere to the [guidelines](#guidelines).

Example:

Expand Down
202 changes: 0 additions & 202 deletions json/linea-goerli-token-shortlist.json

This file was deleted.

Loading