mirror of
https://github.com/kubeshark/kubeshark.git
synced 2026-04-07 03:07:25 +00:00
19 lines
1.1 KiB
Markdown
19 lines
1.1 KiB
Markdown
|
||
# CONTRIBUTE
|
||
We welcome code contributions from the community.
|
||
Please read and follow the guidelines below.
|
||
|
||
## Communication
|
||
* Before starting work on a major feature, please reach out to us via [GitHub](https://github.com/up9inc/mizu), [Slack](https://join.slack.com/share/zt-u6bbs3pg-X1zhQOXOH0yEoqILgH~csw), [email](mailto:mizu@up9.com), etc. We will make sure no one else is already working on it. A _major feature_ is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior
|
||
* Small patches and bug fixes don't need prior communication.
|
||
|
||
## Contribution requirements
|
||
* Code style - most of the code is written in Go, please follow [these guidelines](https://golang.org/doc/effective_go)
|
||
* Go-tools compatible (`go get`, `go test`, etc)
|
||
* Unit-test coverage can’t go down ..
|
||
* Code must be usefully commented. Not only for developers on the project, but also for external users of these packages
|
||
* When reviewing PRs, you are encouraged to use Golang's [code review comments page](https://github.com/golang/go/wiki/CodeReviewComments)
|
||
|
||
|
||
|