mirror of
https://github.com/kubeshark/kubeshark.git
synced 2026-05-28 12:04:31 +00:00
0eb7883a47
* Rename `mizu` to `kubeshark` * Rename `up9inc` to `kubeshark` * Change the logo, title, motto and the main color * Replace the favicon * Update the docs link * Change the copyright text in C files * Remove a comment * Rewrite the `README.md` and update the logo and screenshots used in it * Add a `TODO` * Fix the grammar * Fix the bottom text in the filtering guide * Change the Docker Hub username of cross-compilation intermediate images * Add an install script * Fix `docker/login-action` in the CI * Delete `build-custom-branch.yml` GitHub workflow * Update `README.md` * Remove `install.sh` * Change the motto back to "Traffic viewer for Kubernetes"
21 lines
1.3 KiB
Markdown
21 lines
1.3 KiB
Markdown
|
|
|
|
# Contributing to Kubeshark
|
|
|
|
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/kubeshark/kubeshark), [Slack](https://join.slack.com/share/zt-u6bbs3pg-X1zhQOXOH0yEoqILgH~csw), [email](mailto:kubeshark@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.)
|
|
* Code coverage for unit tests must not decrease.
|
|
* 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)
|
|
* Project follows [Google JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml) for the REST APIs that are provided.
|