Skip to content

Commit

Permalink
CONTRIBUTING: Add a contributing file
Browse files Browse the repository at this point in the history
Based on [1], but with a few local changes like:

* No section about mock tests, because we don't have any.
* Trimmed down section about linting, because we don't do as much of
  that as the installer.
* One sentence per line, so we don't have to worry about rewrapping
  (and complicating diff/blame) as we edit this content going forward.
* Whatever else seemed reasonable when I went through ;).

[1]: https://github.com/openshift/installer/blob/4e46d0a347533263903beb3349a33f53eee7a6c2/CONTRIBUTING.md
  • Loading branch information
wking committed Jun 17, 2020
1 parent 16c5701 commit 2e183d1
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
70 changes: 70 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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-verison-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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,8 @@ go test ./...
export KUBECONFIG=<admin kubeconfig>
TEST_INTEGRATION=1 go test ./... -test.run=^TestIntegration
```

## Contributing

[Contributions welcome](CONTRIBUTING.md)!

0 comments on commit 2e183d1

Please sign in to comment.