Skip to content

Commit b592d72

Browse files
authored
ci: add pr template (#149)
1 parent 3941bd5 commit b592d72

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

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

.licenserc.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ header:
2525
- 'LICENSE'
2626
- 'NOTICE'
2727
- '.github/CODEOWNERS'
28+
- '.github/operatorhub/'
2829
- 'PROJECT'
2930
- '**/go.mod'
3031
- '**/go.sum'

0 commit comments

Comments
 (0)