From 52a44a92b8eb697adb9edf2814c7282b3463a119 Mon Sep 17 00:00:00 2001 From: Nikhita Raghunath Date: Thu, 19 Jul 2018 11:31:27 +0530 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++++++++ README.md | 8 ++++---- 2 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..252a55548 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +Thanks for taking the time to join our community and start contributing! + +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. +See [this document](https://github.com/kubernetes-client/python/blob/master/devel/submodules.md) for more guidelines. + +The [Contributor Guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md) +provides detailed instructions on how to get your ideas and bug fixes seen and accepted. + +Please remember to sign the [CNCF CLA](https://github.com/kubernetes/community/blob/master/CLA.md) and +read and observe the [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/README.md b/README.md index 537131157..e1f40e0f9 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ repo using git submodules. This structure allow other developers to create their own kubernetes client and still use standard kubernetes python utilities. For more information refer to [clients-library-structure](https://github.com/kubernetes-client/community/blob/master/design-docs/clients-library-structure.md). -# Development -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. See [this document](https://github.com/kubernetes-client/python/blob/master/devel/submodules.md) for more guidelines. +## Contributing + +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute. +