Skip to content

Commit

Permalink
github: add templates for issues (open-policy-agent#4006)
Browse files Browse the repository at this point in the history
Creating templates for Bug Reports and Feature Requests

Signed-off-by: Peter ONeill <peteroneilljr@gmail.com>
  • Loading branch information
peteroneilljr committed Nov 17, 2021
1 parent 3e829a3 commit 3d28e67
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 13 deletions.
43 changes: 30 additions & 13 deletions .github/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
<!-- Thanks for opening an issue to request a feature or file a bug!
If you provide some basic information it helps us address problems faster. -->

## Expected Behavior
---
name: Bug report
about: Report a problem for the OPA community to investigate
title: ''
labels: bug
assignees: ''

## Actual Behavior
---

## Steps to Reproduce the Problem
<!-- Thanks for opening an issue to request a feature or file a bug!
If you provide some basic information, it helps us address problems faster. -->

## Short description
<!--
If this is a bug report please provide as much detail as possible so that we can
reproduce the problem. Examples:
Any information you think might be helpful. Examples include the environment
where OPA was running (e.g., if inside Kubernetes, what resource limits did you configure
OPA with?), how long OPA had been running for, what was happening around the time
when you identified the problem, etc.
Examples:
* OPA version
* Example query, input, data, and policy that OPA was given
Expand All @@ -19,11 +27,20 @@ reproduce the problem. Examples:
* For Go and Wasm, the arguments you invoked OPA with
-->

## Additional Info
## Steps To Reproduce
<!--
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See an error
-->

## Expected behavior
<!--
Any additional information you think might be helpful. Examples include the environment
where OPA was running (e.g., if inside Kubernetes, what resource limits did you configure
OPA with?), how long OPA had been running for, what was happening around the time
when you identified the problem, etc.
Describe what you expected to happen.
-->

## Additional context
<!--
Add any other context about the problem here.
-->
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Feature request
about: Let us know how we could improve OPA
title: ''
labels: feature-request
assignees: ''

---

<!-- Thanks for opening an issue to request a feature or file a bug!
If you provide some basic information, it helps us address problems faster. -->

## What part of OPA would you like to see improved?
<!--
Is there something challenging or frustrating about OPA that you are trying to improve?
Do you want OPA to integrate with another project or tool?
Why would this improvement make your experience with OPA better?
-->

## Describe the ideal solution
<!--
In the ideal scenario, there are more than enough resources to solve any problem. Describe what this solution would look like if the resources were available.
-->

## Describe a "Good Enough" solution
<!--
In a more realistic world, we have limited time and resources to solve a problem. Describe what a minimum viable solution would look like that still satisfies the requirements. Think about what is a must-have and what is a nice-to-have; now list out the must-haves. Is there an alternate solution that would work just as well?
-->

## Additional Context
<!--
Add in additional information that would help. Do you have links to similar solutions, screenshots of a problem, or mockups of a solution?
-->

0 comments on commit 3d28e67

Please sign in to comment.