Skip to content

Commit a72a3cd

Browse files
committedJul 15, 2021
Pull request template
Signed-off-by: Martin Vala <[email protected]>
1 parent 4953c73 commit a72a3cd

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed
 

‎docs/pull_request_template.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Thanks submitting your Operator. Please check below list before you create your Pull Request.
2+
3+
### New Submissions
4+
5+
* [ ] Are you familiar with our [contribution guidelines](https://github.com/operator-framework/community-operators/blob/master/docs/contributing-via-pr.md)?
6+
* [ ] Have you [packaged and deployed](https://github.com/operator-framework/community-operators/blob/master/docs/testing-operators.md) your Operator for Operator Framework?
7+
* [ ] Have you tested your Operator with all Custom Resource Definitions?
8+
* [ ] 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)?
9+
* [ ] 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)?
10+
* [ ] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing-prerequisites.md#sign-your-work)?
11+
* [ ] Is operator [icon](https://github.com/operator-framework/community-operators/blob/master/docs/packaging-operator.md#operator-icon) set?
12+
13+
### Updates to existing Operators
14+
15+
* [ ] 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)?
16+
* [ ] 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`?
17+
* [ ] 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` ?
18+
* [ ] Have you tested an update to your Operator when deployed via OLM?
19+
* [ ] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing-prerequisites.md#sign-your-work)?
20+
21+
### Your submission should not
22+
23+
* [ ] Modify more than one operator
24+
* [ ] Modify an Operator you don't own
25+
* [ ] Rename an operator - please remove and add with a different name instead
26+
* [ ] Modify any files outside the above mentioned folders
27+
* [ ] Contain more than one commit. **Please squash your commits.**
28+
29+
### Operator Description must contain (in order)
30+
31+
1. [ ] Description about the managed Application and where to find more information
32+
2. [ ] Features and capabilities of your Operator and how to use it
33+
3. [ ] Any manual steps about potential pre-requisites for using your Operator
34+
35+
### Operator Metadata should contain
36+
37+
* [ ] Human readable name and 1-liner description about your Operator
38+
* [ ] Valid [category name](https://github.com/operator-framework/community-operators/blob/master/docs/packaging-operator.md#categories)<sup>1</sup>
39+
* [ ] One of the pre-defined [capability levels](https://github.com/operator-framework/operator-courier/blob/4d1a25d2c8d52f7de6297ec18d8afd6521236aa2/operatorcourier/validate.py#L556)<sup>2</sup>
40+
* [ ] Links to the maintainer, source code and documentation
41+
* [ ] Example templates for all Custom Resource Definitions intended to be used
42+
* [ ] A quadratic logo
43+
44+
Remember that you can preview your CSV [here](https://operatorhub.io/preview).
45+
46+
--
47+
48+
<sup>1</sup> If you feel your Operator does not fit any of the pre-defined categories, file an issue against this repo and explain your need
49+
50+
<sup>2</sup> For more information see [here](https://sdk.operatorframework.io/docs/overview/#operator-capability-level)

0 commit comments

Comments
 (0)
Please sign in to comment.