idk/go-i2p
1
0
Fork 0
mirror of https://github.com/go-i2p/go-i2p.git synced 2025-07-03 21:05:06 -04:00
Code Issues Packages Projects Releases Wiki Activity

update contributing

Browse Source
This commit is contained in:
Hayden Parker
2016-06-19 15:41:23 -07:00
parent 1c0230369d
commit d6f1d2fca3
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -8,7 +8,7 @@ Fork go-i2p and clone it into your workspace. Make sure you can execute `go tes
## I2P Specifications
The I2P community maintains up-to-date [specifications](https://geti2p.net/spec) of most of the application, which are being used to create go-i2p. Currently, most the of common data structures (located in `lib/common/`) have been implemented and tested, and serve as a good examples.
The I2P community maintains up-to-date [specifications](https://geti2p.net/spec) of most of the application, which are being used to create go-i2p. Currently, most the of common data structures (located in `lib/common/`) have been implemented and tested, and serve as good examples.
## Testing
@ -16,20 +16,20 @@ The I2P community maintains up-to-date [specifications](https://geti2p.net/spec)
## Conventions
### Logging
#### Logging
Logrus is used for logging across all of go-i2p. All log statements should contain an `at` fields and a `reason` field. Here is a good example from the go-i2p implementation of a LeaseSet:
```go
log.WithFields(log.Fields(
"at": "(LeaseSet) PublicKey",
"data_len": remainer_len,
"required_len": LEASE_SET_PUBKEY_SIZE,
"reason": "not enough data",
"at": "(LeaseSet) PublicKey",
"data_len": remainer_len,
"required_len": LEASE_SET_PUBKEY_SIZE,
"reason": "not enough data",
)).Error("error parsing public key")
```
### Testing
#### Testing
Testify is used to assert test cases in all tests in go-i2p for simplicity. Here is an example from the RouterInfo tests: