CONTRIBUTING.md

Table of Contents generated with DocToc

• Contributing guidelines
  • Contributions
  • Certificate of Origin
  • Contributing A Patch
  • Issue and Pull Request Management
  • Pre-check before submitting a PR
  • Build images

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.

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.

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 this repo and clone the forked repo to your $GOPATH/src/open-cluster-management.io/api directory.
4. After your code changes is ready to commit, please run following commands to check your code.

   make update
   make verify

5. Submit a pull request.

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