Skip to content
This repository has been archived by the owner on Jul 14, 2019. It is now read-only.

Latest commit

 

History

History
42 lines (33 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.41 KB
Raw

Contributing guidelines

Sign the CLA

Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests. Please see git.k8s.io/commonuity/CLA.md for more info.

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owners will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork the desired repo, develop and test your code changes.
  5. Submit a pull request.

Using Linters

You can run the linters against the code with

make check

This will check go, yaml, and markdown for linting errors if you have the required applications installed:

  • go: The go linter, golangci-lint, will install itself. Follow the link for its documentation.
  • yaml: The yaml linter, yamllint is packaged for most distros. Installation instructions and documentation can be found at yamllint.readthedocs.io.
  • markdown: The markdown linter, markdownlint-cli needs node.js and npm installed to install it. See the link for installation instructions and documentation.