Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add issue templates #233

Merged
merged 3 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.