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

Add issue templates #98

Merged
merged 2 commits into from
Jan 9, 2024
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 Amphion.
title: "[BUG]: "
labels: 'bug'
assignees: ''

---

## Describe the bug
(A clear and concise description of what the bug is.)

## How To Reproduce
Steps to reproduce the behavior:
1. Config/File changes: ...
2. Run command: ...
3. 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 Information
- Operating System: [e.g. Ubuntu 20.04.5 LTS]
- Python Version: [e.g. Python 3.9.15]
- Driver & CUDA Version: [e.g. Driver 470.103.01 & CUDA 11.4]
- Error Messages and Logs: [If applicable, provide any error messages or relevant log outputs]

## Additional context
(Add any other context about the problem here.)
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/docs_feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Docs feedback
about: Improve documentation about Amphion.
title: "[Docs]: "
labels: 'documentation'
assignees: ''

---

## Documentation Reference
(Path/Link to the documentation file)

## Feedback on documentation
(Your suggestions to the documentation. e.g., accuracy, complex explanations, structural organization, practical examples, technical reliability, and consistency)

## Additional context
(Add any other context or screenshots about the documentation 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 Amphion.
title: "[Feature]: "
labels: 'enhancement'
assignees: ''

---

## Is your feature request related to a problem? Please describe.
(A clear and concise description of what the problem is.)

## 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.)
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/help_wanted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Help wanted
about: Want help from Amphion team.
title: "[Help]: "
labels: 'help wanted'
assignees: ''

---

## Problem Overview
(Briefly and clearly describe the issue you're facing and seeking help with.)

## Steps Taken
(Detail your attempts to resolve the issue, including any relevant steps or processes.)
1. Config/File changes: ...
2. Run command: ...
3. See errors: ...

## Expected Outcome
(A clear and concise description of what you expected to happen.)

## Screenshots
(If applicable, add screenshots to help explain your problem.)

## Environment Information
- Operating System: [e.g. Ubuntu 20.04.5 LTS]
- Python Version: [e.g. Python 3.9.15]
- Driver & CUDA Version: [e.g. Driver 470.103.01 & CUDA 11.4]
- Error Messages and Logs: [If applicable, provide any error messages or relevant log outputs]

## Additional context
(Add any other context about the problem here.)