Skip to content

Commit

Permalink
Create basic contribution doc (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
jmrossy authored May 6, 2024
1 parent ea7d288 commit e6f5fe3
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 16 deletions.
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### Description

#### Type: <New | Updated> <Network | Warp Route>

#### Network(s): <Network Name(s)>

#### Other notes

### Backward compatibility

<!--
Are these changes backward compatible? Note, additions are backwards compatible.
Yes/No
-->

### Testing

<!--
Have any new metadata configs and deployment addresses been used with any Hyperlane tooling, such as the CLI?
-->
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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](https://explorer.hyperlane.xyz) and the [CLI](https://docs.hyperlane.xyz/docs/reference/cli). For example, users will be able to search for messages to chains using [Permissionless Interoperability](https://docs.hyperlane.xyz/docs/reference/glossary#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](https://docs.hyperlane.xyz/docs/reference/registries).
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hyperlane Registry

A collection of configs, artifacts, and schemas for Hyperlane.
A collection of configs, artifacts, and schemas for Hyperlane. See the [documentation](https://docs.hyperlane.xyz/docs/reference/registries) for more information.

## Contents

Expand All @@ -11,8 +11,6 @@ Structured as a folder for each chain. Each folder should contain a `metadata.ya

### Deployments

**WORK IN PROGRESS: Note, the shape and contents of the deployments folders are subject to change**

#### Core

Configs and artifacts for [Hyperlane Core Contract](https://docs.hyperlane.xyz/docs/deploy/deploy-hyperlane) deployments.
Expand All @@ -21,17 +19,6 @@ Configs and artifacts for [Hyperlane Core Contract](https://docs.hyperlane.xyz/d

Address artifacts for [Warp Route](https://docs.hyperlane.xyz/docs/deploy/deploy-warp-route) token deployments.

## Usage

### Via the NPM package

```sh
# With npm
npm install @hyperlane-xyz/registry
# Or with yarn
yarn add @hyperlane-xyz/registry
```

### Via SDK utilities
## Contributing

_Coming soon!_
This registry is maintained by the core Hyperlane team but community members are encouraged to add chain and deployment information here! See the [Contribution Guide](./CONTRIBUTING.md) for more information.

0 comments on commit e6f5fe3

Please sign in to comment.