diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000000..f6af92084d94 --- /dev/null +++ b/CONTRIBUTING.md @@ -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/.json`. +- Icons go into `_data/icons/.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