Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add issue and PR templates #41

Merged
merged 3 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/VULN-TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Vulnerabilities detected
labels: security
---
High or critical vulnerabilities detected. Scan results are below:

{{ env.RESULTS }}
87 changes: 87 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
name: "Bug Report"
description: Report a bug in the Kyverno JSON.
title: "[Bug]"
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Please tell us about the bug.
- type: dropdown
id: kyverno-json-version
attributes:
label: Kyverno JSON Version
description: >-
What version of the Kyverno JSON are you running?
options:
- 1.0.0
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Description
description: Describe what happened.
# placeholder: Tell us what you see!
# value: "asdf"
validations:
required: true
- type: textarea
id: bug-reproduce-steps
attributes:
label: Steps to reproduce
description: >-
What are the exact steps needed to reproduce the bug you experienced? Please provide any and all manifests needed to reproduce your issue, including Kyverno policies and test resources.
GitHub supports [syntax highlighting](https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) with code blocks.
# placeholder: Tell us what you see!
value: |-
1.
validations:
required: true
- type: textarea
id: bug-expectations
attributes:
label: Expected behavior
description: What did you expect to happen?
# placeholder: Tell us what you see!
# value: "asdf"
validations:
required: true
- type: textarea
id: bug-screenshots
attributes:
label: Screenshots
description: >-
If you have any screenshots that would help, please paste them below.
GitHub allows you to copy-and-paste directly from the clipboard into the text area.
**Please avoid taking screenshots of either log or terminal output**; paste any textual output in the logs section below.
# placeholder: Tell us what you see!
# value: "asdf"
validations:
required: false
- type: textarea
id: logs
attributes:
label: Logs
description: >-
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
Kyverno JSON logs may be found by passing the -v flag to any command.
render: Shell
- type: input
id: slack
attributes:
label: Slack discussion
description: >-
If this issue is the result of a discussion thread on Slack, please provide the link to the discussion for reference.
# placeholder: ex. [email protected]
validations:
required: false
- type: checkboxes
id: troubleshooting
attributes:
label: Troubleshooting
description: >-
By submitting this issue, you agree that you have performed some basic attempts at researching and solving your problem.
options:
- label: I have searched other issues in this repository and mine is not recorded.
required: true
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: "Feature Request"
description: Suggest a new feature for Kyverno JSON to support.
title: "[Feature] "
labels: ["enhancement", "triage"]
body:
- type: markdown
attributes:
value: |
Please explain the new feature.
- type: textarea
id: problem
attributes:
label: Problem Statement
description: Describe the problem.
placeholder: A clear and concise description of the problem statement.
# value: "asdf"
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution Description
description: Describe the solution you'd like.
placeholder: A clear and concise description of what you want to happen.
# value: "asdf"
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Describe alternatives you've considered.
placeholder: A clear and concise description of any alternative solutions or features you've considered.
# value: "asdf"
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: Any additional context to this enhancement request.
placeholder: Add any other context or screenshots about the feature request here.
# value: "asdf"
validations:
required: false
- type: input
id: slack
attributes:
label: Slack discussion
description: If this feature request is the result of a discussion thread on Slack, please provide the link to the discussion for reference.
# placeholder: ex. [email protected]
validations:
required: false
- type: checkboxes
id: research
attributes:
label: Research
description: By submitting this issue, you agree that you have performed some basic attempts at researching your problem and solution.
options:
- label: I have searched other issues in this repository and mine is not recorded.
required: true
88 changes: 88 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
## Explanation

<!--
In a couple sentences, explain why this PR is needed and what it addresses. This should be an explanation a non-developer user can understand and covers the "why" question. It should also clearly indicate whether this PR represents an addition, a change, or a fix of existing behavior. This explanation will be used to assist in the release note drafting process.

THIS IS MANDATORY.
-->

## Related issue

<!--
Please link the GitHub issue this pull request resolves in the format of `Closes #1234`. If you discussed this change
with a maintainer, please mention her/him using the `@` syntax (e.g. `@JimBugwadia`).

If this change neither resolves an existing issue nor has sign-off from one of the maintainers, there is a
chance substantial changes will be requested or that the changes will be rejected.

You can discuss changes with maintainers in the [Kyverno Slack Channel](https://kubernetes.slack.com/).
-->

## Milestone of this PR
<!--

Add the milestone label by commenting `/milestone 1.2.3`.

-->

## What type of PR is this

<!--

> Uncomment only one ` /kind <>` line, hit enter to put that in a new line, and remove leading white spaces from that line:
>
> /kind api-change
> /kind bug
> /kind cleanup
> /kind design
> /kind documentation
> /kind failing-test
> /kind feature
-->

## Proposed Changes

<!--
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.

**nNOTE***: If this PR results in new or altered behavior which is user facing, you **MUST** read and follow the steps outlined in the [PR documentation guide](pr_documentation.md) and add Proof Manifests as defined below.

-->

### Proof Manifests

<!--
Read and follow the [PR documentation guide](https://github.com/kyverno/kyverno/blob/main/.github/pr_documentation.md) for more details first. This section is for pasting your YAML manifests (Kubernetes resources and Kyverno policies) which allow maintainers to prove the intended functionality is achieved by your PR. Please use proper fenced code block formatting, for example:

# Kubernetes resource

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: roles-dictionary
namespace: default
data:
allowed-roles: "[\"cluster-admin\", \"cluster-operator\", \"tenant-admin\"]"
```
-->

## Checklist

<!--
Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of
them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
-->

- [ ] I have read the [contributing guidelines](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md).
- [ ] I have read the [PR documentation guide](https://github.com/kyverno/kyverno/blob/main/.github/pr_documentation.md) and followed the process including adding proof manifests to this PR.
- [ ] This is a bug fix and I have added unit tests that prove my fix is effective.
- [ ] This is a feature and I have added CLI tests that are applicable.
- [ ] My PR needs to be cherry picked to a specific release branch which is <replace>.

## Further Comments

<!--
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution
you did and what alternatives you considered, etc...
-->