From 7e2ea394787062cf278b6b0f4f72ca97f5daf78e Mon Sep 17 00:00:00 2001 From: Shunsuke Suzuki Date: Mon, 29 Mar 2021 17:09:54 +0900 Subject: [PATCH] docs: format `Guide of Bug report` (#159) --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 852894aa..b16acd98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,12 +10,13 @@ Please use issue templates as much as possible. ### Guide of Bug report -The code should be runnable for maintainers to reproduce the problem. -We can't reproduce the problem with partial code. -Don't include unknown input variables, local values, resources, etc. -If you can reproduce the problem with public Docker images, please don't use private Docker images. -Don't include unneeded resources to reproduce the problem. -Don't set unneeded attributes to reproduce the problem. +* The code should be runnable for maintainers to reproduce the problem + * We can't reproduce the problem with partial code + * Don't include unknown input variables, local values, resources, etc + * If you can reproduce the problem with public Docker images, please don't use private Docker images +* The code should be simple as much as possible. The simple code helps us to understand and reproduce the problem + * Don't include unneeded resources to reproduce the problem + * Don't set unneeded attributes to reproduce the problem ## Setup your machine