From 406f45f9ab53c80974a6ad87e5d659ad734b11a2 Mon Sep 17 00:00:00 2001 From: EncodedVenom Date: Fri, 12 Jul 2024 22:31:18 -0400 Subject: [PATCH] init bug / feat templates --- .github/ISSUE_TEMPLATE/BUG-REPORT.md | 22 ++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md | 27 +++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.md diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.md b/.github/ISSUE_TEMPLATE/BUG-REPORT.md new file mode 100644 index 0000000..7ab58bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.md @@ -0,0 +1,22 @@ +--- +name: Bug report +about: File a bug report for any behavior that you believe is unintentional or problematic +title: "[BUG]" +labels: bug +assignees: '' + +--- + +## Describe the bug +Put a clear and concise description of what the bug is. This should be short and to the point, not to exceed more than a paragraph. Put the details inside your reproduction steps. + +## Reproduction +Make an easy-to-follow guide on how to reproduce it. Does it happen all the time? Will specific features affect reproduction? All these questions should be answered for a good issue. + +This is a good place to put rbxl files or scripts that help explain your reproduction steps. + +## Expected Behavior +What you expect to happen + +## Actual Behavior +What actually happens \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md new file mode 100644 index 0000000..fb1db1a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.md @@ -0,0 +1,27 @@ +--- +name: Feature Request +about: File a feature request for something you believe should be added to jecs. +title: "[FEATURE]" +labels: feature +assignees: '' + +--- + +## Describe your Feature + +You should explain your feature here, and the motivation for why you want it. + +## Implementation + +Explain how you would implement your feature here. Provide relevant API examples and such here (if applicable). + +## Alternatives + +What other alternative implementations or otherwise relevant information is important to why you decided to go with this specific implementation? + +## Considerations + +Some questions that need to be answered include the following: +- Will old code break in response to this feature? +- What are the performance impacts with this feature (if any)? +- How is it useful to include?