Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

87 lines (63 loc) · 2.99 KB

Table of Contents

Contributing guidelines

Terms

All contributions to the repository must be submitted under the terms of the Apache Public License 2.0.

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.

DCO Sign Off

You must sign off your commit to state that you certify the DCO. To certify your commit for DCO, add a line like the following at the end of your commit message:

Signed-off-by: John Smith <[email protected]>

This can be done with the --signoff option to git commit. See the Git documentation for details.

Code of Conduct

The Open Cluster Management project has adopted the CNCF Code of Conduct. Refer to our Community Code of Conduct for details.

Contributing a patch

  1. Submit an issue describing your proposed change to the repository in question. The repository owners will respond to your issue promptly.
  2. Fork the desired repository, then develop and test your code changes.
  3. Submit a pull request.

In order to contribute a binary to acm-cli, add a new line to build/cli_map.csv. The file is in CSV (Comma Separated Values) format with the following columns:

  • Git URL
  • Build command
  • Build output directory

So the new line would be formatted as:

<git-url>,<build-command>,<build-output-directory>

The expectation is that the output binary filenames in the build output directory are formatted as <os>-<arch>-<binary_name>. The CLI packaging script greedily strips all characters before the final dash ('-') to determine the filename of the binary inside the packaged archive and packages it with the Apache license from this repository.

Issue and pull request management

Anyone can comment on issues and submit reviews for pull requests. In order to be assigned an issue or pull request, you can leave a /assign <your Github ID> comment on the issue or pull request (PR).

Pre-check before submitting a PR

Before submitting a PR, please perform the following steps:

make fmt
make lint
make build-image
make e2e-test