diff --git a/CODESHELTER.md b/CODESHELTER.md new file mode 100644 index 000000000000..d63efd9275db --- /dev/null +++ b/CODESHELTER.md @@ -0,0 +1,34 @@ +# Note to Code Shelter maintainers + +The `multi-geth` project is an extension of upstream +[go-ethereum](https://github.com/ethereum/go-ethereum) that add more +blockchain network support. Some philosophical notes to maintainers: + +* We accept all patches to add new network supports, as long as it's + reasonable. In other words, we don't reject new network supports due + to political reasons. +* We follow upstream closely. + +Besides checking out new PR to merge, please also help out following +upstream and making new releases. Thank you! + +## Merge Upstream Changes + +Add `https://github.com/ethereum/go-ethereum` to one of your +remote. Then pull the upstream `master` branch (note that it must be +`master` branch!), resolve conflicts and create a new PR. + +When you review a merge-upstream PR, please make sure it is merged via +a merge commit. + +## Making New Releases + +Whenever the upstream makes a new release, multi-geth usually makes a +new release as well. Besides, new releases can also be made when a +notable new feature is added in multi-geth. + +To create a new release, branch off `master` into a release branch +`release/vx.x.x`. Change `VersionMeta` to `stable` in +`params/version.go`. Create a **signed commit** and push it to this +repo. The CI will them automatically build all release binaries. After +all binaries are built, create a Github release on that tag. diff --git a/README.md b/README.md index aee5c9bebdbc..ad2e0314d7ab 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/6874 )](https://godoc.org/github.com/multi-geth/multi-geth) [![Go Report Card](https://goreportcard.com/badge/github.com/multi-geth/multi-geth)](https://goreportcard.com/report/github.com/multi-geth/multi-geth) [![Travis](https://travis-ci.org/multi-geth/multi-geth.svg?branch=master)](https://travis-ci.org/multi-geth/multi-geth) -[![Join the chat at https://gitter.im/ethoxy/multi-geth](https://badges.gitter.im/ethoxy/multi-geth.svg)](https://gitter.im/ethoxy/multi-geth) +[![Code Shelter](https://www.codeshelter.co/static/badges/badge-flat.svg)](https://www.codeshelter.co/) Binary archives are published at https://github.com/multi-geth/multi-geth/releases.