CONTRIBUTING.md

Table of Contents generated with DocToc

• Contributions
• Certificate of Origin
• Contributing A Patch
• Issue and Pull Request Management
• Pre-check before submitting a PR
  • Testing your change
    • Start local version of console

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. Ensure all commits include a Signed-off-by trailer (use git commit -s).
5. 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.

npm run check
npm test

Testing your change

Make sure your kubectl context is set to your target cluster and have Red Hat Advanced Cluster Management installed on the target cluster.

Recommended: Run as OpenShift Console plugins

This is the production deployment model. Always test in this mode before submitting a PR.

npm run setup
npm run plugins

WARNING: Running this script will update some parts of the cluster specified in your KUBECONFIG context.

Access the console at http://localhost:9000

Alternative: Run standalone console

For rapid iteration on features that don't depend on OpenShift Console integration.

npm run setup
npm start

A new console will launch and after approximately 30 seconds you will see the RHACM console at https://localhost:3000

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