diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e36138171 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,54 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Contributing guidelines](#contributing-guidelines) + - [Contributions](#contributions) + - [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). + +## Contributing A Patch + +1. Submit an issue describing your proposed change to the repo in question. +1. The [repo owners](OWNERS) will respond to your issue promptly. +1. Fork the desired repo, develop and test your code changes. +1. 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 the xxx. diff --git a/OWNERS b/OWNERS index 0a6a0c54b..148278501 100644 --- a/OWNERS +++ b/OWNERS @@ -5,4 +5,5 @@ approvers: reviewers: - deads2k - pmorie - +- qiujian16 +- mdelder diff --git a/README.md b/README.md index 0d920e112..cf38f66a8 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# work \ No newline at end of file +# Providing content to managed clusters + +Support a primitive that enables resources to be applied to a managed cluster. + +## Community, discussion, contribution, and support + +Check the [CONTRIBUTING Doc](CONTRIBUTING.md) for how to contribute to the repo. + + + +------ + +## Getting Started + +### Prerequisites + +Check the [Development Doc](docs/development.md) for how to contribute to the repo. + +## Security Response + +If you've found a security issue that you'd like to disclose confidentially please contact Red Hat's Product Security team. Details at https://access.redhat.com/security/team/contact + + \ No newline at end of file diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 000000000..340210d59 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,4 @@ + +# Development + +**Pending Update ...** \ No newline at end of file