Skip to content

Commit

Permalink
docs: add issue templates (#233)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
rjaegers and github-actions[bot] authored Dec 5, 2023
1 parent 427cbc0 commit cabdbbf
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/tool_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Tool request
about: Request to include an additional tool
title: 'Request to include <tool>'
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.

0 comments on commit cabdbbf

Please sign in to comment.