From 9a46dbb681f2f33659e477d77636445e311c3e4c Mon Sep 17 00:00:00 2001 From: Vladimir Safonkin Date: Tue, 2 Feb 2021 10:41:51 +0300 Subject: [PATCH 1/6] Add issue and pr templates --- .github/ISSUE_TEMPLATE/bug_report.md | 18 ++++++------------ .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++++++++++++ .github/pull_request_template.md | 7 +++++++ 3 files changed, 29 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a6287b1..522eec5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,22 +2,16 @@ name: Bug report about: Create a bug report title: '' -labels: '' +labels: bug assignees: '' --- -### Description +**Description:** A clear and concise description of what the bug is. - +**Expected behavior:** A description of what you expected to happen. -### Details +**Actual behavior:** A description of what is actually happening. - +**Repro steps:** +A description with steps to reproduce the issue. If your have a public example or repo to share, please provide the link. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..76000ca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' +--- + +**Description:** +Describe your proposal. + +**Related issue:** +Add issue link. + +**Pull request:** +Add pull request link (if it exists). \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..17b416a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +**Description**: Describe your changes. + +**Related issue:** Add link to related issue. + +**Documentation changes required:** (Y/N) Mark if documentation changes are required. + +**Added tests:** (Y/N) Mark if tests were added or updated according changes. \ No newline at end of file From daad66578afffa44a10d678ddeef3d747d43dfa4 Mon Sep 17 00:00:00 2001 From: Vladimir Safonkin Date: Tue, 2 Feb 2021 17:53:24 +0300 Subject: [PATCH 2/6] Resolve comments --- .github/ISSUE_TEMPLATE/bug_report.md | 21 ++++++++++++++++++--- .github/ISSUE_TEMPLATE/feature_request.md | 8 +------- .github/pull_request_template.md | 12 ++++++++---- 3 files changed, 27 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 522eec5..70396c9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,11 +7,26 @@ assignees: '' --- -**Description:** A clear and concise description of what the bug is. +**Description:** +A clear and concise description of what the bug is. -**Expected behavior:** A description of what you expected to happen. +**Expected behavior:** +A description of what you expected to happen. -**Actual behavior:** A description of what is actually happening. +**Actual behavior:** +A description of what is actually happening. + +**Task version:** +Specify the task version + +**Platform:** +- [ ] Ubuntu +- [ ] macOS +- [ ] Windows + +**Runner type:** +- [ ] Hosted +- [ ] Self-hosted **Repro steps:** A description with steps to reproduce the issue. If your have a public example or repo to share, please provide the link. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 76000ca..2e767a3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,15 +2,9 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: enhancement +labels: feature request assignees: '' --- **Description:** Describe your proposal. - -**Related issue:** -Add issue link. - -**Pull request:** -Add pull request link (if it exists). \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 17b416a..169f689 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,11 @@ -**Description**: Describe your changes. +**Description:** +Describe your changes. -**Related issue:** Add link to related issue. +**Related issue:** +Add link to the related issue. -**Documentation changes required:** (Y/N) Mark if documentation changes are required. +**Documentation changes required:** +- [ ] Mark if documentation changes are required. -**Added tests:** (Y/N) Mark if tests were added or updated according changes. \ No newline at end of file +**Test updates** +- [ ] Mark if tests were added or updated to cover the changes. \ No newline at end of file From c47b497cff91ca9b88332d7f08b48d5c47c1f625 Mon Sep 17 00:00:00 2001 From: Vladimir Safonkin Date: Wed, 3 Feb 2021 12:04:13 +0300 Subject: [PATCH 3/6] Minor fix --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 70396c9..c78a361 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,12 +10,6 @@ assignees: '' **Description:** A clear and concise description of what the bug is. -**Expected behavior:** -A description of what you expected to happen. - -**Actual behavior:** -A description of what is actually happening. - **Task version:** Specify the task version @@ -30,3 +24,9 @@ Specify the task version **Repro steps:** A description with steps to reproduce the issue. If your have a public example or repo to share, please provide the link. + +**Expected behavior:** +A description of what you expected to happen. + +**Actual behavior:** +A description of what is actually happening. \ No newline at end of file From 51b6fb2610f6aabf093859fb1eda882634605a5b Mon Sep 17 00:00:00 2001 From: Vladimir Safonkin Date: Wed, 3 Feb 2021 13:08:40 +0300 Subject: [PATCH 4/6] Rework feature request template --- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2e767a3..38a0f0c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,3 +8,9 @@ assignees: '' **Description:** Describe your proposal. + +**Justification** +Describe a use case for your proposal. + +**Are you willing to submit a PR?** + \ No newline at end of file From 3698118d95491c25a9fa60323efb2209f3474cbc Mon Sep 17 00:00:00 2001 From: Vladimir Safonkin Date: Thu, 4 Feb 2021 13:57:55 +0300 Subject: [PATCH 5/6] Minor fix --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 38a0f0c..983cedd 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -10,7 +10,7 @@ assignees: '' Describe your proposal. **Justification** -Describe a use case for your proposal. +Justification or a use case for your proposal. **Are you willing to submit a PR?** \ No newline at end of file From efeb86e5cee42cddb7dfb959c5b658905343202a Mon Sep 17 00:00:00 2001 From: Vladimir Safonkin Date: Thu, 4 Feb 2021 18:48:16 +0300 Subject: [PATCH 6/6] Minor fixes --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/pull_request_template.md | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 983cedd..c05e753 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -9,7 +9,7 @@ assignees: '' **Description:** Describe your proposal. -**Justification** +**Justification:** Justification or a use case for your proposal. **Are you willing to submit a PR?** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 169f689..ef54aca 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,8 +4,6 @@ Describe your changes. **Related issue:** Add link to the related issue. -**Documentation changes required:** +**Check list:** - [ ] Mark if documentation changes are required. - -**Test updates** - [ ] Mark if tests were added or updated to cover the changes. \ No newline at end of file