From 50e05cf91a90dda0f00064882bb0cc29091dea45 Mon Sep 17 00:00:00 2001 From: Luca Moser Date: Mon, 6 Dec 2021 15:58:55 +0100 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 54 ++++++++++++----------- .github/ISSUE_TEMPLATE/feature_request.md | 35 ++++++--------- 2 files changed, 42 insertions(+), 47 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b828c84f2..dd84ea782 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,36 +1,38 @@ --- -name: Report a bug in the Go client library about: Report a bug labels: bug +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' --- -## Bug description +**Describe the bug** +A clear and concise description of what the bug is. -Briefly describe the bug. +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error -## Version +**Expected behavior** +A clear and concise description of what you expected to happen. -Which version of the library are you running? +**Screenshots** +If applicable, add screenshots to help explain your problem. -## Hardware Specification +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] -What hardware are you using? +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] -## Steps To reproduce the bug - -Explain how the maintainer can reproduce the bug. - -1. -2. -3. - -## Expected behaviour - -Describe what you expect to happen. - -## Actual behaviour - -Describe what actually happens. - -## Errors - -Paste any errors that you see. +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 680e1d962..bbcbbe7d6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,27 +1,20 @@ --- -name: Request a feature for the Go client library about: Request a feature ---- - -## Description - -Briefly describe the feature are requesting. - -## Motivation +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' -Explain why this feature is needed. - -## Requirements - -Write a list of what you want this feature to do. - -1. -2. -3. +--- -## Open questions (optional) +**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 [...] -Anything you want to discuss. +**Describe the solution you'd like** +A clear and concise description of what you want to happen. -## Are you planning to do it yourself in a pull request? +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. -Yes/No. +**Additional context** +Add any other context or screenshots about the feature request here.