Merge pull request #387 from wking/contributing-docs

CONTRIBUTING: Add a contributing file

Author: openshift-merge-robot

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# How to Contribute
+
+The cluster-version operator is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests.
+This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.
+
+## Security Response
+
+If you've found a security issue that you'd like to disclose confidentially, please contact Red Hat's Product Security team.
+Details [here][security].
+
+## Getting Started
+
+- Fork the repository on GitHub.
+- Read the [README](README.md) and [developer documentation](docs/dev) for build and test instructions.
+- Play with the project, submit bugs, submit patches!
+
+### Contribution Flow
+
+Anyone may [file issues][new-issue].
+For contributors who want to work up pull requests, the workflow is roughly:
+
+1. Create a topic branch from where you want to base your work (usually master).
+2. Make commits of logical units.
+3. Make sure your commit messages are in the proper format (see [below](#commit-message-format)).
+4. If necessary, you may use `make update-codegen` to update generated code.
+5. Make sure the tests pass (`go test ./...`), and add any new tests as appropriate.
+6. Push your changes to a topic branch in your fork of the repository.
+7. Submit a pull request to the original repository.
+8. The [repo owners](OWNERS) will respond to your issue promptly, following [the ususal Prow workflow][prow-review].
+
+Thanks for your contributions!
+
+## Coding Style
+
+The coding style suggested by the Golang community is used in installer.
+See the [style doc][golang-style] for details.
+Please follow them when working on your contributions.
+You may also `go fmt ./...` to have Go automatically format your .
+
+## Commit Message Format
+
+We follow a rough convention for commit messages that is designed to answer two questions: what changed and why.
+The subject line should feature the what and the body of the commit should describe the why.
+
+```
+scripts: add the test-cluster command
+
+this uses tmux to set up a test cluster that you can easily kill and
+start for debugging.
+
+Fixes #38
+```
+
+The format can be described more formally as follows:
+
+```
+<subsystem>: <what changed>
+<BLANK LINE>
+<why this change was made>
+<BLANK LINE>
+<footer>
+```
+
+The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters.
+This allows the message to be easier to read on GitHub as well as in various Git tools.
+
+[golang-style]: https://github.com/golang/go/wiki/CodeReviewComments
+[new-issue]: https://github.com/openshift/cluster-version-operator/issues/new
+[prow-review]: https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md#the-code-review-process
+[security]: https://access.redhat.com/security/team/contact

README.md

@@ -55,3 +55,8 @@ go test ./...
 export KUBECONFIG=<admin kubeconfig>
 TEST_INTEGRATION=1 go test ./... -test.run=^TestIntegration
 ```
+
+## Contributing
+
+[Contributions welcome](CONTRIBUTING.md)!
+

lib/resourceread/apiext_test.go

@@ -13,7 +13,7 @@ func TestReadCustomResourceDefinitionOrDie(t *testing.T) {
 		args args
 	}{
 		{
-			name:"v1",
+			name: "v1",
 			args: args{
 				objBytes: []byte(`
 apiVersion: apiextensions.k8s.io/v1
@@ -42,7 +42,7 @@ spec:
 			},
 		},
 		{
-			name:"v1beta1",
+			name: "v1beta1",
 			args: args{
 				objBytes: []byte(`
 apiVersion: apiextensions.k8s.io/v1beta1
@@ -82,4 +82,4 @@ spec:
 			_ = ReadCustomResourceDefinitionOrDie(tt.args.objBytes)
 		})
 	}
-}
+}

pkg/autoupdate/autoupdate.go

@@ -7,7 +7,6 @@ import (
 
 	"github.com/blang/semver"
 
-	"k8s.io/klog"
 	v1 "github.com/openshift/api/config/v1"
 	clientset "github.com/openshift/client-go/config/clientset/versioned"
 	"github.com/openshift/client-go/config/clientset/versioned/scheme"
@@ -23,6 +22,7 @@ import (
 	"k8s.io/client-go/tools/cache"
 	"k8s.io/client-go/tools/record"
 	"k8s.io/client-go/util/workqueue"
+	"k8s.io/klog"
 )
 
 const (

pkg/cvo/cvo_test.go

@@ -27,8 +27,8 @@ import (
 	"k8s.io/apimachinery/pkg/util/diff"
 	"k8s.io/apimachinery/pkg/watch"
 	"k8s.io/client-go/discovery"
-	"k8s.io/client-go/rest"
 	kfake "k8s.io/client-go/kubernetes/fake"
+	"k8s.io/client-go/rest"
 	ktesting "k8s.io/client-go/testing"
 	"k8s.io/client-go/util/workqueue"
 	"k8s.io/klog"
@@ -2581,7 +2581,7 @@ func TestOperator_availableUpdatesSync(t *testing.T) {
 			optr: Operator{
 				defaultUpstreamServer:      "http://localhost:8080/graph",
 				minimumUpdateCheckInterval: 1 * time.Minute,
-				availableUpdates:    &availableUpdates{
+				availableUpdates: &availableUpdates{
 					Upstream:    "http://localhost:8080/graph",
 					Channel:     "fast",
 					LastAttempt: time.Now(),