Skip to content

Latest commit

 

History

History
20 lines (12 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

20 lines (12 loc) · 1.19 KB

Contributing

This registry is maintained by the core Hyperlane team, but community members are encouraged to add chain and deployment information here!

Benefits

By adding chain metadata, deployment addresses, and other information here, you make it easier to use with Hyperlane tooling, such as the Explorer and the CLI. For example, users will be able to search for messages to chains using Permissionless Interoperability without having to specify the metadata themselves.

Process

  1. Fork and clone the registry repository
  2. Use the CLI and set the --registry flag to the local path of the cloned repository
  3. Execute your commands as needed, such as hyperlane deploy core --registry <YOUR_URI>
  4. Push your changes to your fork and create a pull request

Once you've opened a PR, the Hyperlane team will review it. If it meets the requirements, it will be merged into the registry.

Documentation

For more information about Hyperlane Registries see the documentation.