Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
davekaj committed Jan 27, 2021
1 parent 331ad06 commit e40b4f9
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ This repository contains the code for the Graph Network Subgraph. The mainnet ve

# Contributing to the repository

Contributions are always welcome! Likely you will want to create a PR against `mainnet-staging`. If you are unsure you can always reach out to us on discord.
## Submitting bugs

Please submit bugs as an issue in this repository.
## Maintaining the repository

This repository has three different configurations for the `testnet`, `mainnet`, and
`mainnet-staging` subgraphs. These can be seen in the npm scripts.

Expand All @@ -13,18 +19,15 @@ will have different contract addresses populated depending on whether we are usi
mainnet. Ensure the npm package for `@graphprotocol/contracts` is set to the newest rinkeby
or mainnet package, [which you can find here](https://www.npmjs.com/package/@graphprotocol/contracts).

## Submitting bugs

Please submit bugs as an issue in this repository.

## Maintaining the repository

The setup for each branch is:

```
master - The code on master will always match the subgraph deployed to
graph-network-mainnet in the explorer, as well as the version of the subgraph
the gateway is using. All code must be reviewed before merging to master.
The front end team should also confirm mainnet-staging works before the
master branch can be updated.
When master is updated a hook will automatically deploy the subgraph to the
hosted service.
Expand All @@ -47,6 +50,10 @@ In general, the workflow should be:
path if it has contract updates that do not yet exist on `mainnet`. And then care will have to
be taken to cherry-pick these updates into `master` when the contract updates are on `mainnet`.

### Versioning

Everytime a new release is merged into `master` there will be a new github release, following semantic versioning.

# Deploying the subgraph

The npm scripts are set up to deploy the subgraphs in one command. Mainnet is connected to a hook
Expand Down

0 comments on commit e40b4f9

Please sign in to comment.