diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 181384bf72..feecd43eac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,12 +2,28 @@ ## Sign the CLA -Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests. Please see https://git.k8s.io/community/CLA.md for more info +Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests. + +Please see https://git.k8s.io/community/CLA.md for more info -### Contributing A Patch +## Contributing steps 1. Submit an issue describing your proposed change to the repo in question. 1. The [repo owners](OWNERS) will respond to your issue promptly. 1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above). 1. Fork the desired repo, develop and test your code changes. 1. Submit a pull request. + +## Test locally + +1. Setup tools + ```bash + $ go get -u github.com/golang/dep/cmd/dep + $ go get -u gopkg.in/alecthomas/gometalinter.v2 + $ gometalinter.v2 --install # if can't load package, refer: https://github.com/alecthomas/gometalinter/issues/404 + ``` +1. Test + ```bash + TRACE=1 ./hack/check-everything.sh + ``` + diff --git a/README.md b/README.md index 90a5f041ec..0767c424a6 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,12 @@ You can reach the maintainers of this project at: - Slack channel: [#kubebuilder](http://slack.k8s.io/#kubebuilder) - Google Group: [kubebuilder@googlegroups.com](https://groups.google.com/forum/#!forum/kubebuilder) -### Code of conduct +## Contributing +Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers. +The project follows the typical GitHub pull request model. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. +Before starting any work, please either comment on an existing issue, or file a new one. + +## Code of conduct Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). +