From cfad1d011871125bfe4740d2ff00977dfddc8873 Mon Sep 17 00:00:00 2001 From: Nikhita Raghunath Date: Mon, 13 Aug 2018 21:58:12 +0530 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..47de6aa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +Thanks for taking the time to join our community and start contributing! + +Please remember to read and observe the [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). + +This project accepts contribution via github [pull requests](https://help.github.com/articles/about-pull-requests/). This document outlines the process to help get your contribution accepted. Please also read the [Kubernetes contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md) which provides detailed instructions on how to get your ideas and bug fixes seen and accepted. + +## Sign the Contributor License Agreement +We'd love to accept your patches! Before we can accept them you need to sign Cloud Native Computing Foundation (CNCF) [CLA](https://github.com/kubernetes/community/blob/master/CLA.md). + +## Reporting an issue +If you have any problem with the package or any suggestions, please file an [issue](https://github.com/kubernetes-client/go-base/issues). + +## Contributing a Patch +1. Submit an issue describing your proposed change to the repo. +2. Fork this repo, develop and test your code changes. +3. Submit a pull request. +4. The bot will automatically assigns someone to review your PR. Check the full list of bot commands [here](https://prow.k8s.io/command-help). + +### Contact +You can reach the maintainers of this project at [SIG API Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery) or on the [#kubernetes-client](https://kubernetes.slack.com/messages/kubernetes-client) channel on the Kubernetes slack. diff --git a/README.md b/README.md index 36b1719..632ddd4 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,5 @@ For more information refer to [clients-library-structure](https://github.com/kub Any changes to utilites in this repo should be send as a PR to this repo. After the PR is merged, developers should create another PR in the main repo to update the submodule. + +For more details on how to contribute, please see [CONTRIBUTING.md](CONTRIBUTING.md).