From 5d58b9dffba4070c0a77305b3c5df760814bb45e Mon Sep 17 00:00:00 2001 From: daimond113 Date: Tue, 18 Feb 2025 00:31:21 +0100 Subject: [PATCH] docs: update issue templates --- .../{bug_report.md => 01-bug-report.md} | 9 +++++---- ...ature_request.md => 02-feature-request.md} | 3 +-- ...equest.md => 03-engine-support-request.md} | 19 +++++++++---------- .github/ISSUE_TEMPLATE/config.yaml | 1 + 4 files changed, 16 insertions(+), 16 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.md => 01-bug-report.md} (87%) rename .github/ISSUE_TEMPLATE/{feature_request.md => 02-feature-request.md} (98%) rename .github/ISSUE_TEMPLATE/{engine-support-request.md => 03-engine-support-request.md} (61%) create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/01-bug-report.md similarity index 87% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/01-bug-report.md index 4bbeb84..94c96c2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/01-bug-report.md @@ -1,10 +1,9 @@ --- name: Bug report about: Create a report to help us improve -title: '' +title: "" labels: bug assignees: daimond113 - --- **Describe the bug** @@ -12,6 +11,7 @@ A clear and concise description of what the bug is. **To Reproduce** If the issue is with: + - pesde's library (e.g. linking): 1. include your project's manifest (pesde.toml) 2. if possible, a repository with a minimal reproduction of the issue. @@ -22,8 +22,9 @@ If the issue is with: A clear and concise description of what you expected to happen. **Please complete the following information:** - - pesde: (e.g. 0.6.0) - - Operating system: (e.g. Windows 11, macOS 15, Ubuntu 24.04) + +- pesde: (e.g. 0.6.0) +- Operating system: (e.g. Windows 11, macOS 15, Ubuntu 24.04) **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/02-feature-request.md similarity index 98% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/02-feature-request.md index c3b6ab9..e4d6bb1 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/02-feature-request.md @@ -1,10 +1,9 @@ --- name: Feature request about: Suggest an idea for this project -title: '' +title: "" labels: enhancement assignees: daimond113 - --- **Is your feature request related to a problem? Please describe.** diff --git a/.github/ISSUE_TEMPLATE/engine-support-request.md b/.github/ISSUE_TEMPLATE/03-engine-support-request.md similarity index 61% rename from .github/ISSUE_TEMPLATE/engine-support-request.md rename to .github/ISSUE_TEMPLATE/03-engine-support-request.md index 203bca5..2ee7118 100644 --- a/.github/ISSUE_TEMPLATE/engine-support-request.md +++ b/.github/ISSUE_TEMPLATE/03-engine-support-request.md @@ -4,7 +4,6 @@ about: Suggest a new engine title: "[ENGINE]" labels: enhancement assignees: daimond113 - --- **General information about the engine** @@ -12,20 +11,20 @@ Name: Lune Repository: https://github.com/lune-org/lune **Checklist** -| Question | Answer | +| Question | Answer | |--------------------------------------------------------------------------------------|--------| -| Is this engine versioned according to [SemVer](https://semver.org/spec/v2.0.0.html)? | | -| Does this engine provide pre-compiled builds? | | -| Will the engine get support for at least a year after it gets added to pesde? | | -| Does the engine have any notable differences to plain Luau (e.g. IO APIs)? | | -| Does the engine correctly implement `require` (according to Luau's RFCs)? | | -| Is the engine open-source under a reasonably permissive license? | | +| Is this engine versioned according to [SemVer](https://semver.org/spec/v2.0.0.html)? | | +| Does this engine provide pre-compiled builds? | | +| Will the engine get support for at least a year after it gets added to pesde? | | +| Does the engine have any notable differences to plain Luau (e.g. IO APIs)? | | +| Does the engine correctly implement `require` (according to Luau's RFCs)? | | +| Is the engine open-source under a reasonably permissive license? | | If the answer is "no" to any of these questions, the engine will not be added. **Additional information** -| Question | Answer | +| Question | Answer | |--------------------------------------------------------------------------------------|--------| -| Are you willing to submit a pull request adding the engine (and a target for it)? | | +| Are you willing to submit a pull request adding the engine (and a target for it)? | | These questions can help fast-track the engine being added. diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false