From bddea5414cc8e9e41c2a5682c69b7b8abbb927d9 Mon Sep 17 00:00:00 2001 From: Steven Zou Date: Tue, 28 Aug 2018 13:52:06 +0800 Subject: [PATCH] Update the issue templates - update bug template - add proposal template Signed-off-by: Steven Zou --- .github/ISSUE_TEMPLATE | 5 ----- .github/ISSUE_TEMPLATE/issue_template.md | 17 +++++++++++++++++ .github/ISSUE_TEMPLATE/proposal_template.md | 14 ++++++++++++++ 3 files changed, 31 insertions(+), 5 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE create mode 100644 .github/ISSUE_TEMPLATE/issue_template.md create mode 100644 .github/ISSUE_TEMPLATE/proposal_template.md diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE deleted file mode 100644 index e03611d79..000000000 --- a/.github/ISSUE_TEMPLATE +++ /dev/null @@ -1,5 +0,0 @@ -If you are reporting a problem, please make sure the following information are provided: -1)Version of docker engine and docker-compose. -2)Config files of harbor, you can get them by packaging "harbor.cfg" and files in the same directory, including subdirectory. -3)Log files, you can get them by package the /var/log/harbor/ . - diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md new file mode 100644 index 000000000..0d5ffa261 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template.md @@ -0,0 +1,17 @@ +If you are reporting a problem, please make sure the following information are provided: + +**Expected behavior and actual behavior:** +A clear and concise description of what you expected to happen and what's the actual behavior. If applicable, add screenshots to help explain your problem. + +**Steps to reproduce the problem:** +Please provide the steps to reproduce this problem. + +**Versions:** +Please specify the versions of following systems. +- harbor version: [x.x.x] +- docker engine version: [y.y.y] +- docker-compose version: [z.z.z] + +**Additional context:** +* **Harbor config files:** You can get them by packaging `harbor.cfg` and files in the same directory, including subdirectory. +* **Log files:** You can get them by package the `/var/log/harbor/` . \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/proposal_template.md b/.github/ISSUE_TEMPLATE/proposal_template.md new file mode 100644 index 000000000..92eabe4e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal_template.md @@ -0,0 +1,14 @@ +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe the main design/architecture of your solution** +A clear and concise description of what does your solution look like. Rich text and diagrams are preferred. + +**Describe the development plan you've considered** +A clear and concise description of the plan to make the solution ready. It can include a development timeline, resource estimation, and other related things. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file