From 9d1b42d07a156307ff0ef5bc4ddd9ce17c9b6975 Mon Sep 17 00:00:00 2001 From: Torin Sandall Date: Thu, 30 Apr 2020 14:51:24 -0400 Subject: [PATCH] Flesh out the ISSUE_TEMPLATE.md file a bit Providing some examples of the kinds of info that are helpful in reproducing bugs in OPA. Signed-off-by: Torin Sandall --- ISSUE_TEMPLATE.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 0e3c8122aa..937f07b0b7 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -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.