Skip to content

Commit d7475ff

Browse files
nikhitabrendandburns
authored andcommitted
Add CONTRIBUTING.md (#77)
1 parent d8e6b8c commit d7475ff

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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+
which provides detailed instructions on how to get your ideas and bug fixes seen and accepted.
11+
12+
## Sign the Contributor License Agreement
13+
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).
14+
15+
## Reporting an issue
16+
If you have any problem with the package or any suggestions, please file an [issue](https://github.com/kubernetes-client/gen/issues).
17+
18+
## Contributing a Patch
19+
1. Submit an issue describing your proposed change to the repo.
20+
2. Fork this repo, develop and test your code changes.
21+
3. Submit a pull request.
22+
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).
23+
24+
### Contact
25+
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

+3
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,6 @@ cd ${CLIENT_ROOT}/...
3434
${GEN_REPO_ROOT}/openapi/autoupdate.sh
3535
```
3636

37+
## Contributing
38+
39+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.

0 commit comments

Comments
 (0)