Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

84 lines (56 loc) · 3.43 KB
Raw

Table of Contents generated with DocToc

Contributing guidelines

Contributions

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.

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. Fork the desired repo, develop and test your code changes.
  4. Submit a pull request.

Adding a New Component

  1. Submit an issue describing the proposed component and a brief description of its architecture and subcomponents.
  2. The repo owners will respond the issue promptly.
  3. Ensure your component meets the following standards as outlined in this doc.
  4. To ensure the component is installed as part of the MCH, further code changes to the MCH Operator are required to allow for an AppSub to be created and managed.

Issue and Pull Request Management

Anyone may comment on issues and submit reviews for pull requests. However, in order to be assigned an issue or pull request, you must be a member of the stolostron GitHub organization.

Repo maintainers can assign you an issue or pull request by leaving a /assign <your Github ID> comment on the issue or pull request.

Pull Request Etiquette

Anyone may submit a pull request, although in order to ensure that the pull request can be responded to properly, link the associated issue in the PR.

We request that all PRs which contribute new code into the repo also contain their associated unit and function tests.

Pre-check before submitting a PR

After your PR is ready to commit, please run following commands to check your code.

make unit-test

Build images

Make sure your code build passed.

make image

Now, you can follow the getting started guide to work with the open-cluster-management API repository.