From 8580732e9e591d90141fe1bf287a8787b1c65ade Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 9 Apr 2024 21:52:38 +0200 Subject: [PATCH 1/4] Add issue templates --- .gitea/issue_template/bugreport.yml | 114 +++++++++++++++++++++++ .gitea/issue_template/config.yml | 8 ++ .gitea/issue_template/featurerequest.yml | 53 +++++++++++ .gitea/issue_template/helprequest.yml | 85 +++++++++++++++++ 4 files changed, 260 insertions(+) create mode 100644 .gitea/issue_template/bugreport.yml create mode 100644 .gitea/issue_template/config.yml create mode 100644 .gitea/issue_template/featurerequest.yml create mode 100644 .gitea/issue_template/helprequest.yml diff --git a/.gitea/issue_template/bugreport.yml b/.gitea/issue_template/bugreport.yml new file mode 100644 index 0000000..e57a183 --- /dev/null +++ b/.gitea/issue_template/bugreport.yml @@ -0,0 +1,114 @@ +name: '⚠️ Bug report' +description: 'Report a bug in the framework.' +title: 'bug: ' +labels: Bug/New +body: + - type: 'markdown' + id: 'text-introduction' + attributes: + value: | + Hey there! Thank you for taking the time to report a bug report to us. + This means a lot to us as that's the only way to get better... and many people don't file bug reports. + Anyway, please answer the following questions accurately, otherwise we won't be able to help you. + **Note: Please check if the same bug report already exists. If not, continue. If so, participate in that one instead.** + **Note: Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.** + - type: 'textarea' + id: 'bug-description' + attributes: + label: 'Bug description' + description: 'Explain what the bug is about. Include as many details as possible.' + placeholder: 'My cat spontaneously explodes when I try to download `https://yourdick.zip`.' + validations: + required: true + - type: 'textarea' + id: 'bug-log' + attributes: + label: 'Bug log' + description: 'For us to understand the problem you're having please insert the ENTIRE log file here. You must give us `DIAG` level logs (set `logger_level` in CORE's configuration to `CoreTypes.LoggerLevel.DIAG` during initialization). **Leave this empty if you give us a reproduction project.**' + placeholder: 'Your log file here...' + value: | +
+ Your log file here... + Note: We wrap the log in the `details` tag so the log doesn't take up too much space in the issue. Please don't remove them. +
+ validations: + required: false + - type: 'textarea' + id: 'bug-snippet' + attributes: + label: 'Bug snippet' + description: 'Insert a snippet of your code that you think is causing the issue. **Leave this empty if you give us a reproduction project.**' + value: | +
+ Your code snippet here... + Note: We wrap the snippet in the `details` tag so the code doesn't take up too much space in the issue. Please don't remove them. +
+ validations: + required: false + - type: 'textarea' + id: 'bug-reproduce' + attributes: + label: 'Bug reproduction guide' + description: 'Explain how we can reproduce this bug as easy as possible step by step.' + placeholder: | + 1. Initialize CORE with the standard configuration + 2. Use any of `erm` functions to download from `https://yourdick.zip`. `parse_utf8`/`return_utf8`'s value is irrelevant. + 3. Wait for it to download. + 4. The nearest cat explodes in the next few seconds. + validations: + required: true + - type: 'input' + id: 'bug-reproduce-project' + attributes: + label: 'Bug reproduction project' + description: 'Drop a link to some repository or a zip file of an example project showcasing the bug *if the bug is a bit more advanced, needs specific timing, etc.*. Please check if the bug actually occurs in that example project!' + placeholder: 'https://your.reproduction.project/download/url/here' + validations: + required: false + - type: 'dropdown' + id: 'framework-branch' + attributes: + label: 'Branch' + description: 'What branch are you using?' + options: + - stable + - develop + validations: + required: true + - type: 'input' + id: 'framework-version-or-commit' + attributes: + label: 'Version/Commit' + description: 'Name the version (for the stable branch) or the commit (for the develop branch) here.' + placeholder: 'ex. v505-r69 OR ed4647c750f67cb6108c845ed6291dae9627cf56' + validations: + required: true + - type: 'input' + id: 'godot-version' + attributes: + label: 'Godot Version' + description: 'Name the engine version you are using. You can copy it by starting the editor's project manager and clicking on the version text in the top right corner.' + placeholder: 'ex. v4.2.1.stable.flathub [b09f793f5]' + validations: + required: true + - type: 'input' + id: 'godot-custom' + attributes: + label: 'Modified engine vendor' + description: 'Name the custom engine name and/or link if the engine you are using isn't directly built from Godot's source code (i.e. a fork). **Leave empty if you're not using a fork of the Godot Engine.**' + placeholder: 'e.g. godot-vita (https://github.com/SonicMastr/godot-vita)' + validations: + required: false + - type: 'input' + id: 'os' + attributes: + label: 'Target operating system' + description: 'Name the target operating system, it's version (if applicable) and architecture (if the OS supports more than one architecture) here. If you're developing a phone game and the issue only occurs on Android/iOS, don't name your desktop operating system here.' + placeholder: 'e.g. Android 14 on arm64 or Windows 11 on amd64 or Arch Linux or Debian trixie on arm64 or FreeBSD on amd64 or UwUntu or TempleOS' + validations: + required: true + - type: 'markdown' + id: 'text-tysm' + attributes: + value: | + Thank you for filling out this bug report. Please check your answers before sending this report. diff --git a/.gitea/issue_template/config.yml b/.gitea/issue_template/config.yml new file mode 100644 index 0000000..dea5a71 --- /dev/null +++ b/.gitea/issue_template/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 📚 Documentation + about: Visit the documentation. Maybe your answer is written somewhere on there instead. + url: https://core.staropensource.de + - name: ❓ Infrequently Asked Questions + about: There we cover some questions you may ask yourself (or not). + url: https://core.staropensource.de/iaq diff --git a/.gitea/issue_template/featurerequest.yml b/.gitea/issue_template/featurerequest.yml new file mode 100644 index 0000000..62c084c --- /dev/null +++ b/.gitea/issue_template/featurerequest.yml @@ -0,0 +1,53 @@ +name: '✨ Feature Request' +description: 'Request a feature to be implemented in the framework.' +title: 'feat: ' +labels: FeatureRequest/New +body: + - type: 'markdown' + id: 'text-introduction' + attributes: + value: | + Hey there! Thank you for taking the time to report a feature request to us. + Before filling any of this out, please think for one minute if the feature is really important and necessary for all/many projects to have. + If not it would probably best to write a custom module for the feature you want added. + Please answer the following questions accurately, otherwise we may not be able to add the feature. + **Note: Please check if the same feature request already exists. If not, continue. If so, participate in that one instead.** + **Note: Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.** + - type: 'textarea' + id: 'feature-description' + attributes: + label: 'Feature description' + description: 'Explain *what* you want added. Also describe why this feature can't implemented without integrating it into the CORE Framework. Include as many details as possible.' + placeholder: | + Example: + I want to do XY in my project, which is fairely hard to implement but would benefit a lot of projects. + validations: + required: true + - type: 'textarea' + id: 'feature-implementation' + attributes: + label: 'Feature implementation' + description: 'Explain *how* you want it added. Include as many details as possible. Also include alternative ways of implementing the feature in the framework (if possible).' + placeholder: | + Example: + I would propose to . + I've also thought on simply . + validations: + required: true +- type: 'textarea' + id: 'feature-alternatives' + attributes: + label: 'Feature alternatives' + description: 'Explain how could be possible to implement the feature without building it into the framework directly. Include as many details as possible. **Leave empty if it can't simply be solved by adding a module.**' + placeholder: | + Example: + I've considered using a custom module for this feature. + Otherwise it would be possible to use . + I've also considered using the engine's way of doing it by . + validations: + required: false + - type: 'markdown' + id: 'text-tysm' + attributes: + value: | + Thank you for filling out this feature request form. Please check your answers before sending this report. diff --git a/.gitea/issue_template/helprequest.yml b/.gitea/issue_template/helprequest.yml new file mode 100644 index 0000000..25e2b0a --- /dev/null +++ b/.gitea/issue_template/helprequest.yml @@ -0,0 +1,85 @@ +name: '💬 Help' +description: 'Request help.' +title: 'help: ' +labels: Help/Wanted +body: + - type: 'markdown' + id: 'text-introduction' + attributes: + value: | + Hey there! Seems like you have some kind of issue with the CORE Framework. + Please answer the following questions accurately, otherwise we won't be able to help you. + **Note: Please check if someone has had the same issue before. If not, continue. If so, participate in that one instead.** + **Note: Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your stuff, we censor our answers.** + - type: 'textarea' + id: 'help-description' + attributes: + label: 'Problem description' + description: 'Explain what your problem is as detailed as possible.' + placeholder: 'How can I reposition scenes inside a scene collection?' + validations: + required: true + - type: 'textarea' + id: 'help-log' + attributes: + label: 'Log' + description: 'For us to understand the problem you're having please insert the ENTIRE log file here. You must give us `DIAG` level logs (set `logger_level` in CORE's configuration to `CoreTypes.LoggerLevel.DIAG` during initialization). **Leave this empty if your problem does not need log output or doesn't involve code at all.**' + placeholder: 'Your log file here...' + value: | +
+ Your log file here... + Note: We wrap the log in the `details` tag so the log doesn't take up too much space in the issue. Please don't remove them. +
+ validations: + required: false + - type: 'textarea' + id: 'help-snippet' + attributes: + label: 'Code snippet' + description: 'Insert a snippet of your code that you need help with. **Leave this empty if your problem does not need log output or doesn't involve code at all.**' + value: | +
+ Your code snippet here... + Note: We wrap the snippet in the `details` tag so the code doesn't take up too much space in the issue. Please don't remove them. +
+ validations: + required: false + - type: 'dropdown' + id: 'framework-branch' + attributes: + label: 'Branch' + description: 'What branch are you using?' + options: + - stable + - develop + validations: + required: true + - type: 'input' + id: 'framework-version-or-commit' + attributes: + label: 'Version/Commit' + description: 'Name the version (for the stable branch) or the commit (for the develop branch) here.' + placeholder: 'ex. v505-r69 OR ed4647c750f67cb6108c845ed6291dae9627cf56' + validations: + required: true + - type: 'input' + id: 'godot-version' + attributes: + label: 'Godot Version' + description: 'Name the engine version you are using. You can copy it by starting the editor's project manager and clicking on the version text in the top right corner.' + placeholder: 'ex. v4.2.1.stable.flathub [b09f793f5]' + validations: + required: true + - type: 'input' + id: 'godot-custom' + attributes: + label: 'Modified engine vendor' + description: 'Name the custom engine name and/or link if the engine you are using isn't directly built from Godot's source code (i.e. a fork). **Leave empty if you're not using a fork of the Godot Engine.**' + placeholder: 'e.g. godot-vita (https://github.com/SonicMastr/godot-vita)' + validations: + required: false + - type: 'markdown' + id: 'text-tysm' + attributes: + value: | + Thank you for filling out this help form. Please check your answers before sending your help request. From 62762ed4e26477fcfdd6a776e2ecf248a1b9f33d Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 9 Apr 2024 22:57:47 +0200 Subject: [PATCH 2/4] Fix description, labels and '' --- .gitea/issue_template/bugreport.yml | 5 +++-- .gitea/issue_template/config.yml | 12 ++++++------ .gitea/issue_template/featurerequest.yml | 5 +++-- .gitea/issue_template/helprequest.yml | 5 +++-- 4 files changed, 15 insertions(+), 12 deletions(-) diff --git a/.gitea/issue_template/bugreport.yml b/.gitea/issue_template/bugreport.yml index e57a183..fd71f6d 100644 --- a/.gitea/issue_template/bugreport.yml +++ b/.gitea/issue_template/bugreport.yml @@ -1,7 +1,8 @@ name: '⚠️ Bug report' -description: 'Report a bug in the framework.' +about: 'Report a bug in the framework.' title: 'bug: ' -labels: Bug/New +labels: + - 'Bug/New' body: - type: 'markdown' id: 'text-introduction' diff --git a/.gitea/issue_template/config.yml b/.gitea/issue_template/config.yml index dea5a71..cef3ed4 100644 --- a/.gitea/issue_template/config.yml +++ b/.gitea/issue_template/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: - - name: 📚 Documentation - about: Visit the documentation. Maybe your answer is written somewhere on there instead. - url: https://core.staropensource.de - - name: ❓ Infrequently Asked Questions - about: There we cover some questions you may ask yourself (or not). - url: https://core.staropensource.de/iaq + - name: '📚 Documentation' + about: 'Visit the documentation. Maybe your answer is written somewhere on there instead.' + url: 'https://core.staropensource.de' + - name: '❓ Infrequently Asked Questions' + about: 'There we cover some questions you may ask yourself (or not).' + url: 'https://core.staropensource.de/iaq' diff --git a/.gitea/issue_template/featurerequest.yml b/.gitea/issue_template/featurerequest.yml index 62c084c..0180c8f 100644 --- a/.gitea/issue_template/featurerequest.yml +++ b/.gitea/issue_template/featurerequest.yml @@ -1,7 +1,8 @@ name: '✨ Feature Request' -description: 'Request a feature to be implemented in the framework.' +about: 'Request a feature to be implemented in the framework.' title: 'feat: ' -labels: FeatureRequest/New +labels: + - 'FeatureRequest/New' body: - type: 'markdown' id: 'text-introduction' diff --git a/.gitea/issue_template/helprequest.yml b/.gitea/issue_template/helprequest.yml index 25e2b0a..e518d45 100644 --- a/.gitea/issue_template/helprequest.yml +++ b/.gitea/issue_template/helprequest.yml @@ -1,7 +1,8 @@ name: '💬 Help' -description: 'Request help.' +about: 'Request help.' title: 'help: ' -labels: Help/Wanted +labels: + - 'Help/Wanted' body: - type: 'markdown' id: 'text-introduction' From f478b381f216d20c6daff0f49a8e48f8467009e1 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Tue, 9 Apr 2024 22:58:04 +0200 Subject: [PATCH 3/4] Add pull request templates --- .gitea/pull_request_template/bugfix.md | 13 +++++++++++++ .gitea/pull_request_template/documentation.md | 13 +++++++++++++ .gitea/pull_request_template/miscellaneous.md | 13 +++++++++++++ .gitea/pull_request_template/mixed.md | 13 +++++++++++++ .gitea/pull_request_template/newfeature.md | 13 +++++++++++++ .gitea/pull_request_template/qualityoflife.md | 13 +++++++++++++ .gitea/pull_request_template/update.md | 13 +++++++++++++ 7 files changed, 91 insertions(+) create mode 100644 .gitea/pull_request_template/bugfix.md create mode 100644 .gitea/pull_request_template/documentation.md create mode 100644 .gitea/pull_request_template/miscellaneous.md create mode 100644 .gitea/pull_request_template/mixed.md create mode 100644 .gitea/pull_request_template/newfeature.md create mode 100644 .gitea/pull_request_template/qualityoflife.md create mode 100644 .gitea/pull_request_template/update.md diff --git a/.gitea/pull_request_template/bugfix.md b/.gitea/pull_request_template/bugfix.md new file mode 100644 index 0000000..6bbd640 --- /dev/null +++ b/.gitea/pull_request_template/bugfix.md @@ -0,0 +1,13 @@ +--- +name: '🪱 Bugfix' +about: 'Submit a pull request which fixes a bug in the framework code.' +title: 'bugfix: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/Bugfix' +--- + diff --git a/.gitea/pull_request_template/documentation.md b/.gitea/pull_request_template/documentation.md new file mode 100644 index 0000000..a908812 --- /dev/null +++ b/.gitea/pull_request_template/documentation.md @@ -0,0 +1,13 @@ +--- +name: '📚 Documentation' +about: 'Submit a pull request which updates the documentation. Do not create your pull request with this template if your PR is implementing a new feature or updating dependencies.' +title: 'docs: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/Documentation' +--- + diff --git a/.gitea/pull_request_template/miscellaneous.md b/.gitea/pull_request_template/miscellaneous.md new file mode 100644 index 0000000..f082628 --- /dev/null +++ b/.gitea/pull_request_template/miscellaneous.md @@ -0,0 +1,13 @@ +--- +name: '🎯 Miscellaneous' +about: 'Submit a pull request which does not update the documentation, adds a new feature, introduces quality of life changes, or fixes a bug.' +title: 'misc: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/Miscellaneous' +--- + diff --git a/.gitea/pull_request_template/mixed.md b/.gitea/pull_request_template/mixed.md new file mode 100644 index 0000000..0555c0d --- /dev/null +++ b/.gitea/pull_request_template/mixed.md @@ -0,0 +1,13 @@ +--- +name: '🧋 Mixed' +about: 'Submit a pull request which updates multiple regions of the CORE source code and documentation.' +title: 'mixed: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/Mixed' +--- + diff --git a/.gitea/pull_request_template/newfeature.md b/.gitea/pull_request_template/newfeature.md new file mode 100644 index 0000000..c4975b8 --- /dev/null +++ b/.gitea/pull_request_template/newfeature.md @@ -0,0 +1,13 @@ +--- +name: '➕ New Feature' +about: 'Submit a pull request which introduces a new feature into the framework.' +title: 'feat: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/NewFeature' +--- + diff --git a/.gitea/pull_request_template/qualityoflife.md b/.gitea/pull_request_template/qualityoflife.md new file mode 100644 index 0000000..04d387d --- /dev/null +++ b/.gitea/pull_request_template/qualityoflife.md @@ -0,0 +1,13 @@ +--- +name: '💖 Quality of Life' +about: 'Submit a pull request which improves the developer experience.' +title: 'qol: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/QualityOfLife' +--- + diff --git a/.gitea/pull_request_template/update.md b/.gitea/pull_request_template/update.md new file mode 100644 index 0000000..2951a07 --- /dev/null +++ b/.gitea/pull_request_template/update.md @@ -0,0 +1,13 @@ +--- +name: '📩 Update' +about: 'Submit a pull request which updates one of CORE's dependencies.' +title: 'update: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/Update' +--- + From a4101373a3c4aaa5f626f5f03ea5063bc9d67582 Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Wed, 10 Apr 2024 00:42:19 +0200 Subject: [PATCH 4/4] Fix issues --- .gitea/issue_template/bugreport.yml | 22 ++++++++------- .gitea/issue_template/featurerequest.yml | 28 +++++++++---------- .gitea/issue_template/helprequest.yml | 18 ++++++------ .gitea/pull_request_template.md | 12 ++++++++ .gitea/pull_request_template/bugfix.md | 13 --------- .gitea/pull_request_template/documentation.md | 13 --------- .gitea/pull_request_template/miscellaneous.md | 13 --------- .gitea/pull_request_template/mixed.md | 13 --------- .gitea/pull_request_template/newfeature.md | 13 --------- .gitea/pull_request_template/qualityoflife.md | 13 --------- .gitea/pull_request_template/update.md | 13 --------- 11 files changed, 47 insertions(+), 124 deletions(-) create mode 100644 .gitea/pull_request_template.md delete mode 100644 .gitea/pull_request_template/bugfix.md delete mode 100644 .gitea/pull_request_template/documentation.md delete mode 100644 .gitea/pull_request_template/miscellaneous.md delete mode 100644 .gitea/pull_request_template/mixed.md delete mode 100644 .gitea/pull_request_template/newfeature.md delete mode 100644 .gitea/pull_request_template/qualityoflife.md delete mode 100644 .gitea/pull_request_template/update.md diff --git a/.gitea/issue_template/bugreport.yml b/.gitea/issue_template/bugreport.yml index fd71f6d..41b4a95 100644 --- a/.gitea/issue_template/bugreport.yml +++ b/.gitea/issue_template/bugreport.yml @@ -8,10 +8,11 @@ body: id: 'text-introduction' attributes: value: | - Hey there! Thank you for taking the time to report a bug report to us. - This means a lot to us as that's the only way to get better... and many people don't file bug reports. - Anyway, please answer the following questions accurately, otherwise we won't be able to help you. - **Note: Please check if the same bug report already exists. If not, continue. If so, participate in that one instead.** + Hey there! Thank you for taking the time to report a bug report to us. \ + This means a lot to us as that's the only way to get better... and many people don't file bug reports. \ + Anyway, please answer the following questions accurately, otherwise we won't be able to help you. \ + \ + **Note: Please check if the same bug report already exists. If not, continue. If so, participate in that one instead.** \ **Note: Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.** - type: 'textarea' id: 'bug-description' @@ -25,7 +26,7 @@ body: id: 'bug-log' attributes: label: 'Bug log' - description: 'For us to understand the problem you're having please insert the ENTIRE log file here. You must give us `DIAG` level logs (set `logger_level` in CORE's configuration to `CoreTypes.LoggerLevel.DIAG` during initialization). **Leave this empty if you give us a reproduction project.**' + description: 'For us to understand the problem you''re having please insert the ENTIRE log file here. You must give us `DIAG` level logs (set `logger_level` in CORE''s configuration to `CoreTypes.LoggerLevel.DIAG` during initialization). **Leave this empty if you give us a reproduction project.**' placeholder: 'Your log file here...' value: |
@@ -41,8 +42,10 @@ body: description: 'Insert a snippet of your code that you think is causing the issue. **Leave this empty if you give us a reproduction project.**' value: |
+ ```gdscript Your code snippet here... Note: We wrap the snippet in the `details` tag so the code doesn't take up too much space in the issue. Please don't remove them. + ```
validations: required: false @@ -88,7 +91,7 @@ body: id: 'godot-version' attributes: label: 'Godot Version' - description: 'Name the engine version you are using. You can copy it by starting the editor's project manager and clicking on the version text in the top right corner.' + description: 'Name the engine version you are using. You can copy it by starting the editor''s project manager and clicking on the version text in the top right corner.' placeholder: 'ex. v4.2.1.stable.flathub [b09f793f5]' validations: required: true @@ -96,7 +99,7 @@ body: id: 'godot-custom' attributes: label: 'Modified engine vendor' - description: 'Name the custom engine name and/or link if the engine you are using isn't directly built from Godot's source code (i.e. a fork). **Leave empty if you're not using a fork of the Godot Engine.**' + description: 'Name the custom engine name and/or link if the engine you are using isn''t directly built from Godot''s source code (i.e. a fork). **Leave empty if you''re not using a fork of the Godot Engine.**' placeholder: 'e.g. godot-vita (https://github.com/SonicMastr/godot-vita)' validations: required: false @@ -104,12 +107,11 @@ body: id: 'os' attributes: label: 'Target operating system' - description: 'Name the target operating system, it's version (if applicable) and architecture (if the OS supports more than one architecture) here. If you're developing a phone game and the issue only occurs on Android/iOS, don't name your desktop operating system here.' + description: 'Name the target operating system, it''s version (if applicable) and architecture (if the OS supports more than one architecture) here. If you''re developing a phone game and the issue only occurs on Android/iOS, don''t name your desktop operating system here.' placeholder: 'e.g. Android 14 on arm64 or Windows 11 on amd64 or Arch Linux or Debian trixie on arm64 or FreeBSD on amd64 or UwUntu or TempleOS' validations: required: true - type: 'markdown' id: 'text-tysm' attributes: - value: | - Thank you for filling out this bug report. Please check your answers before sending this report. + value: 'Thank you for filling out this bug report. Please check your answers before sending this report.' diff --git a/.gitea/issue_template/featurerequest.yml b/.gitea/issue_template/featurerequest.yml index 0180c8f..2c11897 100644 --- a/.gitea/issue_template/featurerequest.yml +++ b/.gitea/issue_template/featurerequest.yml @@ -8,17 +8,18 @@ body: id: 'text-introduction' attributes: value: | - Hey there! Thank you for taking the time to report a feature request to us. - Before filling any of this out, please think for one minute if the feature is really important and necessary for all/many projects to have. - If not it would probably best to write a custom module for the feature you want added. - Please answer the following questions accurately, otherwise we may not be able to add the feature. - **Note: Please check if the same feature request already exists. If not, continue. If so, participate in that one instead.** - **Note: Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.** + Hey there! Thank you for taking the time to report a feature request to us. \ + Before filling any of this out, please think for one minute if the feature is really important and necessary for all/many projects to have. \ + If not it would probably best to write a custom module for the feature you want added. \ + Please answer the following questions accurately, otherwise we may not be able to add the feature. \ + \ + **Note: Please check if the same feature request already exists. If not, continue. If so, participate in that one instead.** \ + **Note: Please don't censor anything *except* sensitive information. You don''t need to be embarrased about your username. You censor your bug report, we censor our answers.** - type: 'textarea' id: 'feature-description' attributes: label: 'Feature description' - description: 'Explain *what* you want added. Also describe why this feature can't implemented without integrating it into the CORE Framework. Include as many details as possible.' + description: 'Explain *what* you want added. Also describe why this feature can''t implemented without integrating it into the CORE Framework. Include as many details as possible.' placeholder: | Example: I want to do XY in my project, which is fairely hard to implement but would benefit a lot of projects. @@ -32,23 +33,22 @@ body: placeholder: | Example: I would propose to . - I've also thought on simply . + I''ve also thought on simply . validations: required: true -- type: 'textarea' + - type: 'textarea' id: 'feature-alternatives' attributes: label: 'Feature alternatives' - description: 'Explain how could be possible to implement the feature without building it into the framework directly. Include as many details as possible. **Leave empty if it can't simply be solved by adding a module.**' + description: 'Explain how could be possible to implement the feature without building it into the framework directly. Include as many details as possible. **Leave empty if it can''t simply be solved by adding a module.**' placeholder: | Example: - I've considered using a custom module for this feature. + I''ve considered using a custom module for this feature. Otherwise it would be possible to use . - I've also considered using the engine's way of doing it by . + I''ve also considered using the engine''s way of doing it by . validations: required: false - type: 'markdown' id: 'text-tysm' attributes: - value: | - Thank you for filling out this feature request form. Please check your answers before sending this report. + value: 'Thank you for filling out this feature request form. Please check your answers before sending this report.' diff --git a/.gitea/issue_template/helprequest.yml b/.gitea/issue_template/helprequest.yml index e518d45..9f120a0 100644 --- a/.gitea/issue_template/helprequest.yml +++ b/.gitea/issue_template/helprequest.yml @@ -8,9 +8,10 @@ body: id: 'text-introduction' attributes: value: | - Hey there! Seems like you have some kind of issue with the CORE Framework. - Please answer the following questions accurately, otherwise we won't be able to help you. - **Note: Please check if someone has had the same issue before. If not, continue. If so, participate in that one instead.** + Hey there! Seems like you have some kind of issue with the CORE Framework. \ + Please answer the following questions accurately, otherwise we won't be able to help you. \ + \ + **Note: Please check if someone has had the same issue before. If not, continue. If so, participate in that one instead.** \ **Note: Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your stuff, we censor our answers.** - type: 'textarea' id: 'help-description' @@ -24,7 +25,7 @@ body: id: 'help-log' attributes: label: 'Log' - description: 'For us to understand the problem you're having please insert the ENTIRE log file here. You must give us `DIAG` level logs (set `logger_level` in CORE's configuration to `CoreTypes.LoggerLevel.DIAG` during initialization). **Leave this empty if your problem does not need log output or doesn't involve code at all.**' + description: 'For us to understand the problem you''re having please insert the ENTIRE log file here. You must give us `DIAG` level logs (set `logger_level` in CORE''s configuration to `CoreTypes.LoggerLevel.DIAG` during initialization). **Leave this empty if your problem does not need log output or doesn''t involve code at all.**' placeholder: 'Your log file here...' value: |
@@ -37,7 +38,7 @@ body: id: 'help-snippet' attributes: label: 'Code snippet' - description: 'Insert a snippet of your code that you need help with. **Leave this empty if your problem does not need log output or doesn't involve code at all.**' + description: 'Insert a snippet of your code that you need help with. **Leave this empty if your problem does not need log output or doesn''t involve code at all.**' value: |
Your code snippet here... @@ -67,7 +68,7 @@ body: id: 'godot-version' attributes: label: 'Godot Version' - description: 'Name the engine version you are using. You can copy it by starting the editor's project manager and clicking on the version text in the top right corner.' + description: 'Name the engine version you are using. You can copy it by starting the editor''s project manager and clicking on the version text in the top right corner.' placeholder: 'ex. v4.2.1.stable.flathub [b09f793f5]' validations: required: true @@ -75,12 +76,11 @@ body: id: 'godot-custom' attributes: label: 'Modified engine vendor' - description: 'Name the custom engine name and/or link if the engine you are using isn't directly built from Godot's source code (i.e. a fork). **Leave empty if you're not using a fork of the Godot Engine.**' + description: 'Name the custom engine name and/or link if the engine you are using isn''t directly built from Godot''s source code (i.e. a fork). **Leave empty if you''re not using a fork of the Godot Engine.**' placeholder: 'e.g. godot-vita (https://github.com/SonicMastr/godot-vita)' validations: required: false - type: 'markdown' id: 'text-tysm' attributes: - value: | - Thank you for filling out this help form. Please check your answers before sending your help request. + value: 'Thank you for filling out this help form. Please check your answers before sending your help request.' diff --git a/.gitea/pull_request_template.md b/.gitea/pull_request_template.md new file mode 100644 index 0000000..22a379c --- /dev/null +++ b/.gitea/pull_request_template.md @@ -0,0 +1,12 @@ +--- +name: 'Pull Request' +about: 'Submit a pull request.' +title: 'new: ' +ref: 'develop' +labels: + - 'PRStatus/Open' + - 'PR/New' +--- + diff --git a/.gitea/pull_request_template/bugfix.md b/.gitea/pull_request_template/bugfix.md deleted file mode 100644 index 6bbd640..0000000 --- a/.gitea/pull_request_template/bugfix.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: '🪱 Bugfix' -about: 'Submit a pull request which fixes a bug in the framework code.' -title: 'bugfix: ' -ref: 'develop' -labels: - - 'PRStatus/Open' - - 'PR/Bugfix' ---- - diff --git a/.gitea/pull_request_template/documentation.md b/.gitea/pull_request_template/documentation.md deleted file mode 100644 index a908812..0000000 --- a/.gitea/pull_request_template/documentation.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: '📚 Documentation' -about: 'Submit a pull request which updates the documentation. Do not create your pull request with this template if your PR is implementing a new feature or updating dependencies.' -title: 'docs: ' -ref: 'develop' -labels: - - 'PRStatus/Open' - - 'PR/Documentation' ---- - diff --git a/.gitea/pull_request_template/miscellaneous.md b/.gitea/pull_request_template/miscellaneous.md deleted file mode 100644 index f082628..0000000 --- a/.gitea/pull_request_template/miscellaneous.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: '🎯 Miscellaneous' -about: 'Submit a pull request which does not update the documentation, adds a new feature, introduces quality of life changes, or fixes a bug.' -title: 'misc: ' -ref: 'develop' -labels: - - 'PRStatus/Open' - - 'PR/Miscellaneous' ---- - diff --git a/.gitea/pull_request_template/mixed.md b/.gitea/pull_request_template/mixed.md deleted file mode 100644 index 0555c0d..0000000 --- a/.gitea/pull_request_template/mixed.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: '🧋 Mixed' -about: 'Submit a pull request which updates multiple regions of the CORE source code and documentation.' -title: 'mixed: ' -ref: 'develop' -labels: - - 'PRStatus/Open' - - 'PR/Mixed' ---- - diff --git a/.gitea/pull_request_template/newfeature.md b/.gitea/pull_request_template/newfeature.md deleted file mode 100644 index c4975b8..0000000 --- a/.gitea/pull_request_template/newfeature.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: '➕ New Feature' -about: 'Submit a pull request which introduces a new feature into the framework.' -title: 'feat: ' -ref: 'develop' -labels: - - 'PRStatus/Open' - - 'PR/NewFeature' ---- - diff --git a/.gitea/pull_request_template/qualityoflife.md b/.gitea/pull_request_template/qualityoflife.md deleted file mode 100644 index 04d387d..0000000 --- a/.gitea/pull_request_template/qualityoflife.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: '💖 Quality of Life' -about: 'Submit a pull request which improves the developer experience.' -title: 'qol: ' -ref: 'develop' -labels: - - 'PRStatus/Open' - - 'PR/QualityOfLife' ---- - diff --git a/.gitea/pull_request_template/update.md b/.gitea/pull_request_template/update.md deleted file mode 100644 index 2951a07..0000000 --- a/.gitea/pull_request_template/update.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: '📩 Update' -about: 'Submit a pull request which updates one of CORE's dependencies.' -title: 'update: ' -ref: 'develop' -labels: - - 'PRStatus/Open' - - 'PR/Update' ---- -