Skip to content

Commit eac6912

Browse files
authored
Merge pull request #130 from interma/more_contri
improve contributing guide
2 parents 2ef903b + fd29bee commit eac6912

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,28 @@
22

33
## Sign the CLA
44

5-
Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests. Please see https://git.k8s.io/community/CLA.md for more info
5+
Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests.
6+
7+
Please see https://git.k8s.io/community/CLA.md for more info
68

7-
### Contributing A Patch
9+
## Contributing steps
810

911
1. Submit an issue describing your proposed change to the repo in question.
1012
1. The [repo owners](OWNERS) will respond to your issue promptly.
1113
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
1214
1. Fork the desired repo, develop and test your code changes.
1315
1. Submit a pull request.
16+
17+
## Test locally
18+
19+
1. Setup tools
20+
```bash
21+
$ go get -u github.com/golang/dep/cmd/dep
22+
$ go get -u gopkg.in/alecthomas/gometalinter.v2
23+
$ gometalinter.v2 --install # if can't load package, refer: https://github.com/alecthomas/gometalinter/issues/404
24+
```
25+
1. Test
26+
```bash
27+
TRACE=1 ./hack/check-everything.sh
28+
```
29+

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ You can reach the maintainers of this project at:
2525
- Slack channel: [#kubebuilder](http://slack.k8s.io/#kubebuilder)
2626
- Google Group: [kubebuilder@googlegroups.com](https://groups.google.com/forum/#!forum/kubebuilder)
2727

28-
### Code of conduct
28+
## Contributing
29+
Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
30+
The project follows the typical GitHub pull request model. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
31+
Before starting any work, please either comment on an existing issue, or file a new one.
32+
33+
## Code of conduct
2934

3035
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
36+

0 commit comments

Comments
 (0)