TrueCloudLab/neo-go
6
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-10-16 05:43:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: drop contribution.md from dev

Browse source 
I don't think it adds anything useful over the existing top-level
CONTRIBUTING.md.
This commit is contained in:
Roman Khimov 2019-08-20 19:09:17 +03:00
parent 4e077838a2
commit d26be7dcc1
1 changed files with 0 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/contribution.md
View file

@ -1,28 +0,0 @@
# Contributions
This document will state guidelines for submitting code.
## Pre-requisites
In order to contribute to Golang, it is essential that you know Golang or language similar to Golang. It is also required that you are familiar with NEO infrastructure.
Reading:
http://docs.neo.org/en-us/network/network-protocol.html
https://tour.golang.org/welcome/1
https://golang.org/doc/effective_go.html#introduction
## 1. Open an Issue Prior
Please open an issue prior to working on the feature, stating the feature you would like to work on.
## 2. Unit test
Unit tests are important, when submitting a PR please ensure that you have at least 70% test coverage.
## 3. Avoid CGo
Due to the complications that come with using CGo, if using it, please provide justification before using it. If using CGo, can provide significant speed boosts and or a large part of the code can be processed in CGo, then we should be able to come to consensus on using it. Generally, it is better to write everything in Golang, so that the code can be maintained by other Gophers.