From 02feb3cb36af59b73a61a5b1f12c201cf68d4943 Mon Sep 17 00:00:00 2001 From: Martin Vala Date: Fri, 16 Jul 2021 00:00:16 +0200 Subject: [PATCH] PR template Signed-off-by: Martin Vala --- docs/pull_request_template.md | 50 +++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/pull_request_template.md diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 00000000000..1f3a7bac949 --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,50 @@ +Thanks submitting your Operator. Please check below list before you create your Pull Request. + +### New Submissions + +* [ ] Are you familiar with our [contribution guidelines](https://github.com/operator-framework/community-operators/blob/master/docs/contributing-via-pr.md)? +* [ ] Have you [packaged and deployed](https://github.com/operator-framework/community-operators/blob/master/docs/testing-operators.md) your Operator for Operator Framework? +* [ ] Have you tested your Operator with all Custom Resource Definitions? +* [ ] Have you tested your Operator in all supported [installation modes](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#operator-metadata)? +* [ ] Have you considered whether you want use [semantic versioning order](https://github.com/operator-framework/community-operators/blob/master/docs/operator-ci-yaml.md#semver-mode)? +* [ ] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing-prerequisites.md#sign-your-work)? +* [ ] Is operator [icon](https://github.com/operator-framework/community-operators/blob/master/docs/packaging-operator.md#operator-icon) set? + +### Updates to existing Operators + +* [ ] Did you create a `ci.yaml` file according to the [update instructions](https://github.com/operator-framework/community-operators/blob/master/docs/operator-ci-yaml.md)? +* [ ] Is your new CSV pointing to the previous version with the `replaces` property if you chose `replaces-mode` via the `updateGraph` property in `ci.yaml`? +* [ ] Is your new CSV referenced in the [appropriate channel](https://github.com/operator-framework/community-operators/blob/master/docs/packaging-operator.md#channels) defined in the `package.yaml` or `annotations.yaml` ? +* [ ] Have you tested an update to your Operator when deployed via OLM? +* [ ] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing-prerequisites.md#sign-your-work)? + +### Your submission should not + +* [ ] Modify more than one operator +* [ ] Modify an Operator you don't own +* [ ] Rename an operator - please remove and add with a different name instead +* [ ] Modify any files outside the above mentioned folders +* [ ] Contain more than one commit. **Please squash your commits.** + +### Operator Description must contain (in order) + +1. [ ] Description about the managed Application and where to find more information +2. [ ] Features and capabilities of your Operator and how to use it +3. [ ] Any manual steps about potential pre-requisites for using your Operator + +### Operator Metadata should contain + +* [ ] Human readable name and 1-liner description about your Operator +* [ ] Valid [category name](https://github.com/operator-framework/community-operators/blob/master/docs/packaging-operator.md#categories)1 +* [ ] One of the pre-defined [capability levels](https://github.com/operator-framework/operator-courier/blob/4d1a25d2c8d52f7de6297ec18d8afd6521236aa2/operatorcourier/validate.py#L556)2 +* [ ] Links to the maintainer, source code and documentation +* [ ] Example templates for all Custom Resource Definitions intended to be used +* [ ] A quadratic logo + +Remember that you can preview your CSV [here](https://operatorhub.io/preview). + +-- + +1 If you feel your Operator does not fit any of the pre-defined categories, file an issue against this repo and explain your need + +2 For more information see [here](https://sdk.operatorframework.io/docs/overview/#operator-capability-level)