From c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26 Mon Sep 17 00:00:00 2001 From: Wei-Ning Huang Date: Sun, 1 Sep 2019 14:20:30 +0800 Subject: Add wiki material --- docs/Contribute-to-Tangerine-Fullnode.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/Contribute-to-Tangerine-Fullnode.md (limited to 'docs/Contribute-to-Tangerine-Fullnode.md') diff --git a/docs/Contribute-to-Tangerine-Fullnode.md b/docs/Contribute-to-Tangerine-Fullnode.md new file mode 100644 index 0000000..3ac2cc1 --- /dev/null +++ b/docs/Contribute-to-Tangerine-Fullnode.md @@ -0,0 +1,22 @@ +# Contribute to Tangerine Fullnode + +Thank you for considering to help out with the source code! We welcome contributions from +anyone on the internet, and are grateful for even the smallest of fixes! + +If you'd like to contribute to go-tangerine, please fork, fix, commit and send a pull request +for the maintainers to review and merge into the main code base. If you wish to submit more +complex changes though, please check up with the core devs first on [our gitter channel](https://gitter.im/byzantine-lab/Lobby) +to ensure those changes are in line with the general philosophy of the project and/or get some +early feedback which can make both your efforts much lighter as well as our review and merge +procedures quick and simple. + +Please make sure your contributions adhere to our coding guidelines: + + * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). + * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. + * Pull requests need to be based on and opened against the `dev` branch. + * Commit messages should be prefixed with the package(s) they modify. + * E.g. "eth, rpc: make trace configs optional" + +Please see the [Developers' Guide](https://github.com/byzantine-lab/go-tangerine/wiki/Developers'-Guide) +for more details on configuring your environment, managing project dependencies and testing procedures. -- cgit