Clarify expectations for contributions

+ Update README
+ Add CONTRIBUTING.md
+ Create a placeholder for development instructions
This commit is contained in:
Michael D. Elder
2020-04-23 12:02:54 -04:00
parent c17a7df9c1
commit 258f273c05
4 changed files with 94 additions and 2 deletions
+54
View File
@@ -0,0 +1,54 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**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)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
# 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 <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.
```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.
+2 -1
View File
@@ -5,4 +5,5 @@ approvers:
reviewers:
- deads2k
- pmorie
- qiujian16
- mdelder
+34 -1
View File
@@ -1 +1,34 @@
# work
# 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.
<!--
You can reach the maintainers of this project at:
- [#xxx on Slack](https://slack.com/signin?redir=%2Fmessages%2Fxxx)
-->
------
## 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
<!--
## XXX References
If you have any further question about xxx, please refer to
[XXX help documentation](docs/xxx_help.md) for further information.
-->
+4
View File
@@ -0,0 +1,4 @@
# Development
**Pending Update ...**