Skip to content

Commit

Permalink
Merge pull request #352 from interma/improve_contri
Browse files Browse the repository at this point in the history
improve contributing guide
  • Loading branch information
k8s-ci-robot committed Aug 10, 2018
2 parents d0f783b + 347b377 commit 581c0cb
Showing 1 changed file with 27 additions and 30 deletions.
57 changes: 27 additions & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
## Sign the CLA

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

### Contributing A Patch
Please see https://git.k8s.io/community/CLA.md for more info.

## Contributing steps

1. Submit an issue describing your proposed change to the repo in question.
1. The [repo owners](OWNERS) will respond to your issue promptly.
Expand All @@ -15,31 +16,29 @@ Please see https://git.k8s.io/community/CLA.md for more info

## How to build kubebuilder locally

Setup:

- Download [google container builder](https://cloud.google.com/container-builder/docs/build-debug-locally)
- Export `OUTPUT` to a location to write the directory containing the final build artifacts

```sh
export OUTPUT=/tmp/kubebuilder
```

Run container-builder:

```sh
container-builder-local --config=build/cloudbuild_local.yaml --dryrun=false \
--write-workspace=$OUTPUT .
```

Extract `tar.gz` from $OUTPUT to /usr/local

## Running kubebuilder tests

```sh
go test ./pkg/...
```

## Community, discussion, contribution, and support
1. Setup tools
1. Download and setup [gcloud](https://cloud.google.com/sdk/docs/downloads-interactive)
1. Install `cloud-build-local` via `gcloud`
```bash
$ gcloud install cloud-build-local
```
1. Build
1. Export `OUTPUT` to a location to write the directory containing the final build artifacts
```sh
$ export OUTPUT=/tmp/kubebuilder
```
2. Run container-builder:
```sh
$ cloud-build-local --config=build/cloudbuild_local.yaml --dryrun=false \
--write-workspace=$OUTPUT .
```
1. Extract `tar.gz` from $OUTPUT to /usr/local
1. Test
```sh
go test ./pkg/...
```

## Community, discussion and support

Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).

Expand All @@ -48,8 +47,6 @@ You can reach the maintainers of this project at:
- [Slack](http://slack.k8s.io/)
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-kubebuilder)

### Code of conduct
## Code of conduct

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

[google container builder]: https://github.com/kubernetes-sigs/container-builder-local

0 comments on commit 581c0cb

Please sign in to comment.