From 3f9ac4863ab3ff5923df67d31f87960982e1c8a7 Mon Sep 17 00:00:00 2001 From: Aaron Spring <aaron.spring@mpimet.mpg.de> Date: Tue, 4 May 2021 12:47:23 +0000 Subject: [PATCH] Update bug.md --- .gitlab/issue_templates/bug.md | 35 +++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md index d13a158..7f60297 100644 --- a/.gitlab/issue_templates/bug.md +++ b/.gitlab/issue_templates/bug.md @@ -1,30 +1,39 @@ -## Summary - -(Summarize the bug encountered concisely) +<!-- Please include a self-contained copy-pastable example that generates the issue if possible -## Steps to reproduce - -(How one can reproduce the issue - this is very important) +Please be concise with code posted. See guidelines below on how to provide a good bug report: -"```python/bash" -code -"```" +- Craft Minimal Bug Reports: http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports +- Minimal Complete Verifiable Examples: https://stackoverflow.com/help/mcve -or link to notebook/gist +--> +## Summary -## Example Project +(Summarize the bug encountered concisely) -(Maybe just create an example project here on GitLab.com that exhibits the problematic -behavior, and link to it here in the bug report) ## What is the current bug behavior? (What actually happens) + ## What is the expected correct behavior? (What you should see instead) + +## Steps to reproduce + +(How one can reproduce the issue - this is very important) + +```python/bash +code +``` + +or link to notebook/gist. + +(Maybe just create an example project here on GitLab.com that exhibits the problematic +behavior, and link to it here in the bug report) + ## Relevant logs and/or screenshots (Paste any relevant logs - please use code blocks (```) to format console output, logs, and code, as -- GitLab