diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dbe1a28 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Report a gameplay bug. Compilation issues do not count. +title: 'Bug report: ' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Write clear step-by-step instructions on how to reproduce the bug from a new world: +1. +2. +3. + +**Expected behavior** +A clear and concise description of what you expected to happen, compared to what actually happened. + +**Screenshots** +If applicable, add screenshots or videos to help explain your problem. + +**Minecraft client details:** +- Version: +- Mods: + +**Platform (if desktop):** + - Operating System: + - CPU: + +**Platform (if ESP variant):** + - Chip: + - Development board: + - Power supply: + - Internet properties: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5715db7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest a gameplay feature or enhancement. Development tooling does not count. +title: 'Feature request:' +labels: feature request +assignees: '' + +--- + +**Describe the feature:** +A clear and concise description of the feature you wish to see implemented. + +**Explain why this feature is necessary:** +A clear and concise explanation of why this feature is important. Consider what compromises are made to memory/performance and weigh your arguments against those. + +**Are you planning on implementing this yourself? If so, explain the approach you intend to take:** diff --git a/.github/ISSUE_TEMPLATE/optimization-idea.md b/.github/ISSUE_TEMPLATE/optimization-idea.md new file mode 100644 index 0000000..49aaf71 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/optimization-idea.md @@ -0,0 +1,16 @@ +--- +name: Optimization idea +about: Suggest a potential memory or performance optimization. +title: 'Optimization: ' +labels: optimization +assignees: '' + +--- + +**Describe the optimization:** +A clear and concise description of the optimization you wish to implement or see implemented. + +**Explain why this feature is necessary:** +A clear and concise explanation of the effects of this optimization, and why it is important. Please remember that this project's priorities are **memory first, performance second**. If your suggestion requires compromising memory usage for performance, make a case for why the tradeoff is worth it. + +**Are you planning on implementing this yourself? If so, explain the approach you intend to take:**