From e6ceeb9284fba0642978311ac876b5d9529d152d Mon Sep 17 00:00:00 2001 From: martoon Date: Fri, 6 Dec 2019 18:36:15 +0300 Subject: [PATCH] Add issue templates Problem: by default, when creating an issue, user has to fill everything from scratch and this is not good. Solution: add issue templates for `task` and `bug`, refer people to page for openning new issue in `CONTRIBUTING.md`. --- .github/CONTRIBUTING.md | 2 +- .github/ISSUE_TEMPLATE/bug.md | 41 ++++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/task.md | 20 +++++++++++++++++ 3 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/task.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1efd552..4bcbee7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,7 +2,7 @@ ## Reporting issues -Please [open an issue](../../../issues) if you find a bug or have a feature request. +Please [open an issue](../../../issues/new/choose) if you find a bug or have a feature request. Note: you need to login (e. g. using your GitHub account) first. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..b3fea7f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,41 @@ +--- +name: Bug report +about: If you think our software behaves not the way it should, report a bug +title: "[BUG]" +labels: '' +assignees: '' + +--- + +# Description + + + +# To Reproduce + +Steps to reproduce the behavior: + + +# Expected behavior + + + +# Environment + +- OS +- branch/revision + +# Additional context + + diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md new file mode 100644 index 0000000..11c41d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.md @@ -0,0 +1,20 @@ +--- +name: Task +about: Suggest a task for this project +title: '' +labels: '' +assignees: '' + +--- + +# Clarification and motivation + + + +# Acceptance criteria + +