Skip to content

Latest commit

 

History

History
110 lines (82 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

110 lines (82 loc) · 4.11 KB
Raw

How to Contribute

CoreOS projects are Apache 2.0 licensed and accept 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.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.

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.

Getting Started

  • Fork the repository on GitHub
  • Install build dependencies.
  • Read the README for build and test instructions
  • Play with the project, submit bugs, submit patches!

Contribution Flow

Anyone may file issues. 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).
  4. Push your changes to a topic branch in your fork of the repository.
  5. Make sure the tests pass, and add any new tests as appropriate.
  6. We run a number of linters and tests on each pull request. You may wish to run these locally before submitting your pull request (Make sure you have podman installed): 
    hack/go-fmt.sh .
hack/go-lint.sh $(go list -f '{{ .ImportPath }}' ./...)
hack/go-vet.sh ./...
hack/shellcheck.sh
hack/tf-fmt.sh -list -check
hack/tf-lint.sh
hack/yaml-lint.sh
hack/go-test.sh
  7. Submit a pull request to the original repository.
  8. The repo owners will respond to your issue promptly, following the ususal Prow workflow.

Thanks for your contributions!

Coding Style

The coding style suggested by the Golang community is used in installer. See the style doc for details. Please follow them when working on your contributions.

Terraform has similar standards, and you can run terraform fmt to rewrite Terraform files to the canonical format.

Import order

The Golang import statements are organized into 4 sections: standard, default, prefix("github.com/openshift"), and blank imports with the gci tool. To automatically sort the imports run:

hack/go-fmt.sh .

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.

Generating Test Mocks

Some unit tests use mocks that are generated with gomock. If the underlying interface for a mock changes, then the mock will need to be regenerated. Use the following to regenerate all of the mocks under the pkg package.

hack/go-genmock.sh