Skip to content

Create CONTRIBUTING.md with contribution guidelines #12

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create CONTRIBUTING.md with contribution guidelines #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributing Guide

Thanks for contributing to **megaeth-labs/chains** (fork of `ethereum-lists/chains`).
This repo stores EVM chain metadata under `_data/chains` using CAIP-2 file names.

## ✅ Before you start
- Each chain lives in `_data/chains/<caip-2>.json`. Example format with required fields is shown in README (name, chain, rpc[], nativeCurrency, explorers[], etc.).
- If you reference an icon (network or explorer), provide a JSON in `_data/icons/<name>.json` with IPFS URLs, width/height, and format (png/jpg/svg). Files must be < 250 KB.
- `shortName` and `name` must be **unique**. If it’s an L2/shard, add a `parent` section linking to an existing parent chain.

## 🔍 Constraints (summary)
- Unique `shortName` and `name`.
- If `parent` is used, the parent chain **must already exist**.
- Icon JSON uses **publicly retrievable IPFS CIDs** (not gateway-only).
- We do **not** delete historical chains; use `"status": "deprecated"` when needed.

## 🧪 Pre-flight checks (please run locally before PR)
```bash
# validate / aggregate
./gradlew run

# format JSON consistently
npx prettier --write _data/*/*.json