Skip to content

Commit

Permalink
Add manual validation checks to comply with Catalog Org TEP
Browse files Browse the repository at this point in the history
We would need to ensure that the PR submissions are manually validated
against the [TEP-003] until we have the [validation tool] added to CI.

Signed-off-by: Sunil Thaha <[email protected]>

---

[TEP-003]: https://github.com/tektoncd/community/blob/master/teps/0003-tekton-catalog-organization.md
[validation tool]: tektoncd#413
  • Loading branch information
sthaha committed Jul 13, 2020
1 parent d7e5c6d commit c8e4415
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,25 @@ review them:
- [ ] Includes [docs](https://github.com/tektoncd/community/blob/master/standards.md#principles) (if user facing)
- [ ] Commit messages follow [commit message best practices](https://github.com/tektoncd/community/blob/master/standards.md#commit-messages)
- [ ] Yaml file complies with [yamllint](https://github.com/adrienverge/yamllint) rules.
- [ ] Complies with [Catalog Orgainization TEP][TEP], see [example]. **Note** [An issue has been filed to automate this validation][validation]
- [ ] File path follows `<kind>/<name>/<version>/name.yaml`
- [ ] Has `README.md` at `<kind>/<name>/<version>/README.md`
- [ ] Has mandatory `metadata.labels` - `app.kubernetes.io/version` the same as the `<version>` of the resource
- [ ] Has mandatory `metadata.annotations` `tekton.dev/pipelines.minVersion`
- [ ] mandatory `spec.description` follows the convention
```yaml
spec:
description: >-
one line summary of the resource

Paragraph(s) to describe the resource.
```

_See [the contribution guide](https://github.com/tektoncd/catalog/blob/master/CONTRIBUTING.md)
for more details._

---

[TEP]: https://github.com/tektoncd/community/blob/master/teps/0003-tekton-catalog-organization.md
[example]: https://github.com/tektoncd/catalog/tree/master/task/git-clone/0.1
[validation]: https://github.com/tektoncd/catalog/issues/413

0 comments on commit c8e4415

Please sign in to comment.