forked from getclave/clave-lists
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CONTRIBUTING
21 lines (11 loc) · 1.52 KB
/
CONTRIBUTING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Contribution Guidelines
Make sure that you are following this contributing guideline and PR template before submitting a PR.
## Adding a new token or updating an existing token
If you are adding a new token or updating an existing token, start by selecting the relevant options.
Please make sure that you have replaced `TOKEN_NAME`, `TOKEN_SYMBOL`, and `CHAIN_ID` with the actual token name, symbol, chain id in the PR template with tokens block explorer link. Also, passed the appropriate json element in the [clave.tokenlist.zksync-mainnet.json](./token-list/clave.tokenlist.zksync-mainnet.json) file.
Please make sure that you have included token logo with `{TOKEN_ADDRESS}.png` name format and in square scaling (preferably 64x64) in the [logos](./token-list/logos) folder.
Please make sure that you have all of the addresses in the lower case format.
## Adding a new dApp or updating an existing dApp
If you are adding a new dApp or updating an existing dApp, start by selecting the relevant options.
Please make sure that you have replaced `DAPP_NAME`, `DAPP_DESCRIPTION`, and `CHAIN_ID` with the actual dApp name and description in the PR template with dApps homepage link. Also, passed the appropriate json element in the [clave.dapplist.json](./dapp-list/clave.dapplist.json) file. You can only include tags from the main tags section, custom tags are not allowed.
Please make sure that you have included dApp logo with `{DAPP_NAME}.png` name format and in square scaling (preferably 64x64) in the [logos](./dapp-list/logos) folder.