Skip to content

Commit 47a40a3

Browse files
committed
Add CONTRIBUTING.md
1 parent a6d42ca commit 47a40a3

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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/). 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.
8+
9+
## Sign the Contributor License Agreement
10+
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).
11+
12+
## Reporting an issue
13+
If you have any problem with the package or any suggestions, please file an [issue](https://github.com/kubernetes-client/javascript/issues).
14+
15+
## Contributing a Patch
16+
1. Submit an issue describing your proposed change to the repo.
17+
2. Fork this repo, develop and test your code changes.
18+
3. Submit a pull request.
19+
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).
20+
21+
### Contact
22+
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
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,7 @@ To run tests, execute the following:
8989
```console
9090
npm test
9191
```
92+
93+
## Contributing
94+
95+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.

0 commit comments

Comments
 (0)