Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

65 lines (48 loc) · 2.64 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.

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 open-cluster-management 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.

Testing your change

Export the following environment variables:

export TARGET_ACTION=hibernating  # Or "running"
export CM_TOKEN=                  # Your OpenShift API token
export CM_API_URL=                # API URL for your cluster https://my.cluster.hostname.com:6443
python3 src/main.py

This will run the code locally, find the available Cloud Provider secrets and check the quotas for the provider.

Build images

Make sure your code build passed.

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

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