Skip to content

Latest commit

 

History

History
122 lines (91 loc) · 6.22 KB

CONTRIBUTING.md

File metadata and controls

122 lines (91 loc) · 6.22 KB
Raw

Contributing to this repository

🔍 step-by-step guide for creating a Pull Request, using the Milestones as an example - link

Don't see your issue? Open one

You can browse existing issues on our github repository.

If you find something wrong with the website or the data feel free to open an issue.

Cloning the repository

We encourage you to fork our repository first and then clone your fork. That way the changes you make will be visible in your repository after you push and you can easily make pull requests. It's easy:

https://github.com/l2beat/l2beat/fork

Installing dependencies

To do any development work, even simple config changes you probably want to have the project running locally. To install dependencies do the following.

  1. Install node.js version 18. To easily manage node versions we recommend fnm
  2. Install pnpm, preferably using Corepack corepack enable pnpm
  3. In the repository root run pnpm install to install project specific dependencies

Running the website locally

If you're planning working only on the frontend part of the website (i.e. you don't care what data is actually displayed) then it's quite easy. Just run the following commands after having cloned the repository:

pnpm install
pnpm build:dependencies
cd packages/frontend
pnpm dev:mock

Add tokens to a project

If while adding your project you find that some of the tokens locked in it are missing from our token list do not worry.

General token prerequisites (without these your token CANNOT be added):

  • Price data on Coingecko: Every token needs to be listed with current price data on Coingecko. (Not just as preview, not just on CoingeckoTerminal)
  • For natively minted tokens: Circulating supply data on Coingecko is essential.

Steps to add a token

  1. Study the general prerequisites (see above) and check if your token complies.
  2. Add your token to the list (packages/config/src/tokens/tokens.jsonc). The order of the tokens should be kept alphabetical.
  3. Run pnpm tokens in the packages/config/ directory.

Refer to the docs - tvl.md for further token insights.

Add your Layer 2 project to the website

If you want to add a new Layer 2 project you can do that by opening a PR. To do this you need to:

  1. Read the specification in packages/config/src/projects/layer2s/types/Layer2.ts. It contains an annotated data format for the project definition.
  2. Add a .ts file to describe your project inside packages/config/src/projects/layer2s. You can use the existing projects and templates (e.g. OP stack and Orbit stack templates in packages/config/src/projects/layer2s/templates/) as reference.
  3. Add your project into packages/config/src/projects/layer2s/index.ts. The order of the projects should be kept alphabetical.
  4. Add a square PNG project icon with a minimum size of 128x128 pixels to packages/frontend/public/icons. From the packages/frontend directory run pnpm tinify-logos afterwards to reduce its size.
  5. Run the website locally to check out your changes. (optional, see above)
  6. Make sure that things like linting, formatting and tests are all passing. To check their status you can run pnpm lint:fix, pnpm format:fix or pnpm test respectively. We greatly encourage doing this before the last step as it shortens the amount of time needed for your project to be added.
  7. Open a PR :D
  8. If your changes contain any errors we might want to fix them ourselves. To make this as easy as possible please enable "Allow edits by maintainers". Otherwise the latency before we can merge a PR greatly increases.

Adding a new project in this way will automatically update both the data fetching logic as well as the frontend.

Add your Layer 3 project to the website

If you want to add a new Layer 3 project you can do that by opening a PR. To do this you need to:

  1. Read the specification in packages/config/src/projects/layer3s/types/Layer3.ts. It contains an annotated data format for the project definition.
  2. Add a .ts file to describe your project inside packages/config/src/projects/layer3s. You can use the existing projects and templates (e.g. OP stack and Orbit stack templates in packages/config/src/projects/layer2s/templates/) as reference. Remember to specify host chain on which your project is based on. Take projectId of host chian and add it to hostChain property.
  3. Add your project to packages/config/src/projects/layer3s/index.ts. The order of the projects should be kept alphabetical.
  4. Add a square PNG project icon with a minimum size of 128x128 pixels into packages/frontend/src/static/icons. From the packages/frontend directory run pnpm tinify-logos afterwards to reduce its size.
  5. Make sure that things like linting, formatting and tests are all passing. To check their status you can run pnpm lint:fix, pnpm format:fix or pnpm test respectively. We greatly encourage doing this before the last step as it shortens the amount of time needed for your project to be added.
  6. Open a PR :D
  7. If your changes contain any errors we might want to fix them ourselves. To make this as easy as possible please enable "Allow edits by maintainers". Otherwise the latency before we can merge a PR greatly increases.

Contribute research

Each project defined in packages/config/src/projects described by a set of parameters (details.parameters). Those values are a result of research conducted by the L2BEAT contributors. As with all research there may be mistakes, outdated information or missing data in those files.

You are encouraged to provide your feedback on the data presented on L2BEAT by opening an issue. Once consensus is reached on what the data presented should be we also very much welcome PRs.

Contribute code

The L2BEAT website repository is a monorepo consisting of many interdependent packages. To learn more about each of the projects read their respective README's.