Skip to content

Commit

Permalink
Merge pull request #111 from JSchmie/JSchmie-patch-1
Browse files Browse the repository at this point in the history
Update issue templates
  • Loading branch information
JSchmie authored Aug 30, 2024
2 parents f258d22 + 1ef3267 commit 1d17ce1
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

## Description 🐛
Please provide a clear and concise description of the bug. What went wrong?

## Steps to Reproduce 🔍
Steps to reproduce the behavior:
1. Go to '...'
2. Run command '....'
3. Provide input '....'
4. See error

## Expected Behavior 🤔
What did you expect to happen instead?

## Screenshots or Logs 📸
If applicable, add screenshots or logs to help explain your problem. This can include terminal output or error messages.

## Environment 🖥️
- **OS**: [e.g., Ubuntu 20.04]
- **Python Version**: [e.g., 3.9]
- **PyTorch Version**: [e.g., 2.0]
- **CUDA Version** (if applicable): [e.g., 11.7]
- **ScrAIbe Version**: [e.g., 1.0.0]
- **Installation Type**: [e.g., pip, GitHub, Docker, etc.]

## Additional Context 📝
Add any other context about the problem here. For example, information about custom models or configurations, related issues, or anything else that might be helpful.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: "[CUSTOM] "
labels: ''
assignees: ''

---

## Description 📝
Provide a detailed description of the issue or request. Explain the context, the problem, or the question you have.

## Objective 🎯
What do you hope to achieve with this issue? Are you looking for guidance, proposing a discussion, or something else?

## Relevant Information 📂
Include any relevant details, such as:
- Code snippets
- Links to related documentation or issues
- Configuration files
- Screenshots or diagrams

## Steps to Reproduce or Reference 🔍
If applicable, provide steps to reproduce the issue or reference specific parts of the project that are relevant to your issue.

## Proposed Next Steps 🚀
What do you propose as the next steps for addressing this issue? Do you need help, or are you suggesting a specific course of action?

## Additional Context 📝
Add any other context that might help understand the issue. This could include environmental details, related discussions, or any other relevant information.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE]"
labels: feature
assignees: ''

---

## Description 📝
Provide a clear and concise description of the feature or enhancement you are proposing. What problem does it solve, or what capability does it add?

## Use Case 💡
Explain the use case(s) for this feature. How would it benefit you or others? Include any relevant examples or scenarios.

## Proposed Solution 🚀
Describe your proposed solution in detail. How would the feature work? If you have an idea of how to implement it, include that here. Code snippets or references to other projects can be helpful.

## Alternatives Considered 🔄
Have you considered any alternative approaches or solutions? If so, please describe them and explain why they wouldn't be as effective.

## Additional Context 📝
Add any other context, screenshots, or mockups that might help clarify your request. This could include links to relevant discussions, related issues, or other resources.

0 comments on commit 1d17ce1

Please sign in to comment.