From cabdbbf2d907d0479df40bea3a73a9da90ecddf7 Mon Sep 17 00:00:00 2001 From: Ron <45816308+rjaegers@users.noreply.github.com> Date: Tue, 5 Dec 2023 11:41:08 +0100 Subject: [PATCH] docs: add issue templates (#233) * docs: add issue templates * Apply linter findings Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * docs: add tool request template --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++ .github/ISSUE_TEMPLATE/tool_request.md | 20 ++++++++++++++ 3 files changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/tool_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..8655e992 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Clone repository '...' in container volume +2. Select build preset '....' +3. Open file '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** +- OS: [e.g. Windows, Linux, OSX] +- Architecture [e.g. x86_64, Apple M2] +- Docker Version [e.g. Docker Desktop 4.25.2] + +**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 new file mode 100644 index 00000000..11fc491e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**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 [...] + +**Describe the solution you'd like** +A clear and concise 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. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/tool_request.md b/.github/ISSUE_TEMPLATE/tool_request.md new file mode 100644 index 00000000..a3180b12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tool_request.md @@ -0,0 +1,20 @@ +--- +name: Tool request +about: Request to include an additional tool +title: 'Request to include ' +labels: enhancement +assignees: '' + +--- + +**What tool would you like to include** +A clear and concise description of the tool you would want to include. Ex. I want to add tool x that does [...] + +**What is the use-case for the inclusion** +Describe why the proposed tool should be added. Please note that project specific tools +should be added to a derived container instead of adding them to amp-devcontainer. + +**What is the estimated size impact** +Describe what the estimated (or absolute) size impact of the inclusion would be on the final +image [size](https://en.wikipedia.org/wiki/Byte#Multiple-byte_units). +Ex. The container image size will increase with 5 MiB.