Skip to content

Commit

Permalink
chore: add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sekwah41 committed Apr 7, 2024
1 parent 6bb3dda commit 2aecbef
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug Report for Library
about: Create a report to help us improve the SekCore Library
title: 'bug: quick summary of what's wrong'
labels: bug
assignees: ''

---

**Describe the Bug**
A clear and concise description of the bug.

**Library and Environment Information**
- SekCore Library Version: [e.g., 2.1.0]
- Minecraft Version: [e.g., 1.16.5]
- Forge/Fabric Version: [Specify version]
- List of Installed Mods: [If applicable, attach a mod list. Especially include mods that interact with this library.]

**Steps to Reproduce**
Please provide detailed steps to reproduce the bug:
1. Execute ... command
2. Trigger ... feature or interaction
(Note: Adjust based on typical library interactions)

**Expected Behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Logs**
- If the game crashes, please attach the crash log. This can greatly aid in diagnosing the issue.
- Include any relevant log output that might not result in a crash but shows errors or warnings.

**Additional Context**
Add any other context about the problem here, such as specific scenarios where the bug occurs or any troubleshooting steps already attempted.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request for SekCore Library
about: Suggest an idea to enhance the library
title: 'feat: Brief description of the feature'
labels: enhancement
assignees: ''

---

**Is Your Feature Request Related to a Problem? Please Describe.**
Please provide a clear and concise description of the problem. For instance, "It's challenging to synchronise player data across different environments without complex code."

**Library and Environment Information**
- SekCore Library Version: [e.g., 2.1.0]
- Minecraft Version: [e.g., 1.16.5]
- Forge/Fabric Version: [Specify version]
- Are you using other mods that interact with SekCore? [yes/no]
- If yes, mention any specific mods that should be considered for compatibility or integration.

**Describe the Solution You'd Like**
Offer a detailed and clear description of what you want to see implemented. Include any specific mechanics, functionalities, or changes you envisage, such as new annotations, utility classes, or methods that could facilitate mod development.

**Describe Alternatives You've Considered**
Provide a concise explanation of any alternative solutions or features you've thought about. This could include mechanisms seen in other libraries or mods, highlighting how they address similar issues or requirements.

**Additional Context**
Add any other context, screenshots, or sketches about the feature request here. This could include code snippets demonstrating how the proposed feature could be used, examples from other technologies illustrating the desired functionality, or more detailed descriptions of how this feature would enhance the SekCore Library's utility for mod creators.

0 comments on commit 2aecbef

Please sign in to comment.