diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f7c26dff1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,62 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Contributing guidelines](#contributing-guidelines) + - [Contributions](#contributions) + - [Certificate of Origin](#certificate-of-origin) + - [Contributing A Patch](#contributing-a-patch) + - [Issue and Pull Request Management](#issue-and-pull-request-management) + - [Pre-check before submitting a PR](#pre-check-before-submitting-a-pr) + - [Build images](#build-images) + + + +# Contributing guidelines + +## Contributions + +All contributions to the repository must be submitted under the terms of the [Apache Public License 2.0](https://www.apache.org/licenses/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](DCO) file for details. + +## Contributing A Patch + +1. Submit an issue describing your proposed change to the repo in question. +2. The [repo owners](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](https://github.com/open-cluster-management) GitHub organization. + +Repo maintainers can assign you an issue or pull request by leaving a +`/assign ` 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. + +```shell +make verify +make test +``` + +## Build images + +Make sure your code build passed. + +```shell +export BUILD_LOCALLY=1 +make +``` + +Now, you can follow the [getting started guide](./README.md#getting-started) to work with this repository. \ No newline at end of file diff --git a/DCO b/DCO new file mode 100644 index 000000000..8201f9921 --- /dev/null +++ b/DCO @@ -0,0 +1,37 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. diff --git a/README.md b/README.md index 4cee7196f..b3b3365b7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Minimum cluster registration and work +## Community, discussion, contribution, and support + +Check the [CONTRIBUTING Doc](CONTRIBUTING.md) for how to contribute to the repo. + # How to Deploy ## Deploy all-in-one deployment on kind