Skip to content

Commit 9a8eef3

Browse files
committed
Add CONTRIBUTING.md
1 parent 9e23b71 commit 9a8eef3

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
Thanks for taking the time to join our community and start contributing!
4+
5+
Please remember to read and observe the [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
6+
7+
This project accepts contribution via github [pull requests](https://help.github.com/articles/about-pull-requests/).
8+
This document outlines the process to help get your contribution accepted.
9+
Please also read the [Kubernetes contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md).
10+
11+
## Sign the Contributor License Agreement
12+
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).
13+
14+
## Reporting an issue
15+
If you have any problem with the package or any suggestions, please file an [issue](https://github.com/kubernetes-client/java/issues).
16+
17+
## Contributing a Patch
18+
1. Submit an issue describing your proposed change to the repo.
19+
2. Fork this repo, develop and test your code changes.
20+
3. Submit a pull request.
21+
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).
22+
23+
### Contact
24+
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.

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -146,19 +146,19 @@ Key:
146146
See the [CHANGELOG](./CHANGELOG.md) for a detailed description of changes
147147
between java-client versions.
148148

149-
## Community, Support, Discussion
149+
## Contributing
150150

151-
You can reach the maintainers of this project at [SIG API Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery). If you have any problem with the package or any suggestions, please file an [issue](https://github.com/kubernetes-client/java/issues).
151+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.
152152

153153
### Code of Conduct
154154

155155
Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
156156

157157
# Development
158158

159-
## Update client
159+
## Update the client
160160

161-
to update the client clone the `gen` repo and run this command at the root of the client repo:
161+
To update the client clone the `gen` repo and run this command at the root of the client repo:
162162

163163
```bash
164164
${GEN_REPO_BASE}/openapi/java.sh kubernetes settings

0 commit comments

Comments
 (0)