From 708b7704acd4066a186e2084026e104298fa7e52 Mon Sep 17 00:00:00 2001 From: "lynn [they]" Date: Thu, 14 Nov 2019 14:06:01 -0800 Subject: [PATCH] Add issue templates --- .github/ISSUE_TEMPLATE/v1-bug-report.md | 44 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/v2-bug-report.md | 44 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/v2-feature-request.md | 30 +++++++++++++ 3 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/v1-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/v2-bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/v2-feature-request.md diff --git a/.github/ISSUE_TEMPLATE/v1-bug-report.md b/.github/ISSUE_TEMPLATE/v1-bug-report.md new file mode 100644 index 0000000..b253666 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/v1-bug-report.md @@ -0,0 +1,44 @@ +--- +name: v1 bug report +about: Create a report to help us fix v1 bugs +title: 'v1 bug: ( your bug title goes here )' +labels: 'type: bug, status: triage, version: v1' +assignees: lynncyrin + +--- + +## Checklist + +* [ ] Are you running the latest v1 release? The list of releases is [here](https://github.com/urfave/cli/releases). +* [ ] Did you check the manual for your release? The v1 manual is [here](https://github.com/urfave/cli/blob/master/docs/v1/manual.md) +* [ ] Did you perform a search about this problem? Here's the [Github guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching. + +## Describe the bug + +A clear and concise description of what the bug is. + +## To reproduce + +Describe the steps or code required to reproduce the behavior + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Additional context + +Add any other context about the problem here. + +If the issue relates to a specific open source Github repo, please link that repo here. + +If you can reproduce this issue with a public CI system, please link a failing build here. + +## Want to fix this yourself? + +We'd love to have more contributors on this project! If the fix for this bug is easily explained and very small, free free to create a pull request for it. You'll want to base the PR off the `v1` branch, all `v1` bug fix releases will be made from that branch. + +## Run `go env` and paste its output here + +``` +# paste it in here +``` diff --git a/.github/ISSUE_TEMPLATE/v2-bug-report.md b/.github/ISSUE_TEMPLATE/v2-bug-report.md new file mode 100644 index 0000000..f238e85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/v2-bug-report.md @@ -0,0 +1,44 @@ +--- +name: v2 bug report +about: Create a report to help us fix v2 bugs +title: 'v2 bug: ( your bug title goes here )' +labels: 'type: bug, version: v2, status: triage' +assignees: '' + +--- + +## Checklist + +* [ ] Are you running the latest v2 release? The list of releases is [here](https://github.com/urfave/cli/releases). +* [ ] Did you check the manual for your release? The v2 manual is [here](https://github.com/urfave/cli/blob/master/docs/v2/manual.md) +* [ ] Did you perform a search about this problem? Here's the [Github guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching. + +## Describe the bug + +A clear and concise description of what the bug is. + +## To reproduce + +Describe the steps or code required to reproduce the behavior + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Additional context + +Add any other context about the problem here. + +If the issue relates to a specific open source Github repo, please link that repo here. + +If you can reproduce this issue with a public CI system, please link a failing build here. + +## Want to fix this yourself? + +We'd love to have more contributors on this project! If the fix for this bug is easily explained and very small, free free to create a pull request for it. + +## Run `go env` and paste its output here + +``` +# paste it in here +``` diff --git a/.github/ISSUE_TEMPLATE/v2-feature-request.md b/.github/ISSUE_TEMPLATE/v2-feature-request.md new file mode 100644 index 0000000..7fef658 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/v2-feature-request.md @@ -0,0 +1,30 @@ +--- +name: v2 feature request +about: Suggest an improvement for v2 +title: 'v2 feature: ( your feature title goes here )' +labels: 'type: feature, version: v2, status: triage' +assignees: '' + +--- + +## Checklist + +* [ ] Are you running the latest v2 release? The list of releases is [here](https://github.com/urfave/cli/releases). +* [ ] Did you check the manual for your release? The v2 manual is [here](https://github.com/urfave/cli/blob/master/docs/v2/manual.md) +* [ ] Did you perform a search about this feature? Here's the [Github guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching. + +## What problem does this solve? + +A clear and concise description of what problem this feature would solve. For example: + +- needing to type out the full flag name takes a long time, so I would like to suggest adding auto-complete +- I use (osx, windows, linux) and would like support for (some existing feature) to be extended to my platform +- the terminal output for a particular error case is confusing, and I think it could be improved + +## Solution description + +A detailed description of what you want to happen. + +## Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered.