Skip to content

docs: add CONTRIBUTING.md with validation and submission rules #17

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

docs: add CONTRIBUTING.md with validation and submission rules #17

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
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contributing Guide — MegaETH Chains

Welcome and thank you for contributing!
This repository contains EVM-compatible chain metadata following the [ethereum-lists/chains](https://github.com/ethereum-lists/chains) schema.

## ✅ Before You Start
- Each chain lives in `_data/chains/<caip-2>.json`.
- Icons go into `_data/icons/<name>.json` with valid IPFS URLs (max 250 KB).
- `shortName` and `name` must be unique across the repo.
- For L2/shard networks, define the `parent` section properly.

## 🧪 Local Validation
Run locally before submitting:
```bash
./gradlew run
npx prettier --write _data/*/*.json