Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

68 lines (51 loc) · 2.76 KB

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.

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.

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.

Pre-check before submitting a PR

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

make compile

Testing your change

Make sure your kubectl context is set to your target cluster. This will run the code locally:

Controller

./build/_output/cluster-curator-controller

You will see the log output on the console. Provision a NEW cluster in ACM with annotation hive.openshift.io/reconcile-pause=true and you will see the controller launch a job. Monitor the job with oc logs jobs/cluster-curator-job-XYZAB Where the job name is found using oc get jobs. The jobs are run in the cluster namespace.

Build images

Make sure your code compiled (passed).

export REPO_URL=<REPO_URL>      # quay.io/my-org
export VERSION=<VERSION>
make build

Now, you can follow the getting started guide to work with the stolostron cluster-curator-controller repository.