Skip to content

Commit

Permalink
Flesh out the ISSUE_TEMPLATE.md file a bit
Browse files Browse the repository at this point in the history
Providing some examples of the kinds of info that are helpful in
reproducing bugs in OPA.

Signed-off-by: Torin Sandall <[email protected]>
  • Loading branch information
tsandall authored and patrick-east committed Apr 30, 2020
1 parent 1095b39 commit 9d1b42d
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# Expected Behavior
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

# Actual Behavior


# Steps to Reproduce the Problem

1.
2.
3.
If this is a bug report please provide as much detail as possible so that we can
reproduce the problem. Examples:

* OPA version
* Example query, input, data, and policy that OPA was given
* Example output that OPA returned
* For server and CLI, the flags/configuration that you provided to OPA
* For server, any relevant log messages from OPA
* For Go and Wasm, the arguments you invoked OPA with

# Additional Info

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.

0 comments on commit 9d1b42d

Please sign in to comment.