From feeaa3ba49f2b4104b79d61cc6a65fbe66e4637a Mon Sep 17 00:00:00 2001 From: Nikita Bykov <49442273+nikita-bykov@users.noreply.github.com> Date: Wed, 20 Oct 2021 12:22:43 +0300 Subject: [PATCH] Add issue and pull request templates (#258) --- .github/ISSUE_TEMPLATE/bug_report.md | 50 ++++++++++------------- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.md | 18 ++++++++ .github/pull_request_template.md | 9 ++++ 4 files changed, 50 insertions(+), 28 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml 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 8ff1a8f..929a5e4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,44 +1,38 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a bug report title: '' -labels: bug +labels: bug, needs triage assignees: '' --- -**Describe the bug** + + + +**Description:** A clear and concise description of what the bug is. -**Which version of the action are you using?** +**Action version:** +Specify the action version -- [ ] `v1` -- [ ] `v2` -- [ ] Some other tag (such as `v2.0.1` or `master`) - -**Environment** -- [ ] self-hosted -- [ ] Linux +**Platform:** +- [ ] Ubuntu +- [ ] macOS - [ ] Windows -- [ ] Mac -If applicable, please specify if you're using a container +**Runner type:** +- [ ] Hosted +- [ ] Self-hosted -**Python Versions** -Please list all of the effected versions of Python (`3.8.2`, etc.) +**Tools version:** + -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**Repro steps:** +A description with steps to reproduce the issue. If your have a public example or repo to share, please provide the link. -**Run/Repo Url** -If applicable, and if your repo/run is public, please include a URL so it is easier for us to investigate. +**Expected behavior:** +A description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. +**Actual behavior:** +A description of what is actually happening. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..1c37027 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: feature request, needs triage +assignees: '' +--- + + + +**Description:** +Describe your proposal. + +**Justification:** +Justification or a use case for your proposal. + +**Are you willing to submit a PR?** + \ 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..ef54aca --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ +**Description:** +Describe your changes. + +**Related issue:** +Add link to the related issue. + +**Check list:** +- [ ] Mark if documentation changes are required. +- [ ] Mark if tests were added or updated to cover the changes. \ No newline at end of file