From 1bca3127456d3718ef5a21d0e25b120399c2f46d Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Sun, 18 Aug 2024 12:00:24 +0200 Subject: [PATCH] Add issue and pull request templates --- .gitea/issue_template/bugreport.yml | 117 +++++++++++++++++++++++ .gitea/issue_template/config.yml | 5 + .gitea/issue_template/featurerequest.yml | 54 +++++++++++ .gitea/issue_template/helprequest.yml | 89 +++++++++++++++++ .gitea/pull_request_template.md | 12 +++ 5 files changed, 277 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 create mode 100644 .gitea/pull_request_template.md diff --git a/.gitea/issue_template/bugreport.yml b/.gitea/issue_template/bugreport.yml new file mode 100644 index 00000000..9ef4dfaf --- /dev/null +++ b/.gitea/issue_template/bugreport.yml @@ -0,0 +1,117 @@ +name: "⚠️ Bug report" +about: "Report a bug in the engine." +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 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 may not be able to diagnose the issue. \ + \ + **Note: Please check if the same bug report already exists. If not, continue. If so, participate in that one instead. If another issue is similar but not the same, make sure to mention the related issues.** \ + **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 from `https://yourdick.zip`." + validations: + required: true + - type: "textarea" + id: "bug-log" + attributes: + label: "Bug log" + description: | + Please insert the ENTIRE log output here, so we can understand the problem at hand. + You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM args) with the default log template. + + **This field can be left empty if the bug does not involve/require log output.** + placeholder: "Your log file here..." + value: | + ```plain + Your log file here... + ``` + validations: + required: false + - type: "textarea" + id: "bug-snippet" + attributes: + label: "Bug snippet" + description: | + Please insert a snippet of the (application and/or engine) code which you think is causing the issue. + + **This field can be left empty if you intend on supplying a reproduction project.** + value: | + ```java + Your code snippet here... + ``` + 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. + + **This field can be left empty if the bug does not involve/require a reproduction guide.** + placeholder: | + 1. Pass "-Dsosengine.base.optimizeLogging=false" to the JVM + 2. Override logging implementation + 2. Initialize engine + 4. The nearest cat should explode in the next few seconds + validations: + required: false + - type: "input" + id: "bug-reproduce-project" + attributes: + label: "Bug reproduction project" + description: | + Drop a link to some repository or zip file of an example project showcasing the bug. + + **Only supply a repro project if the bug is a bit more advanced, needs specific timing, etc..** \ + **Also please make sure that the bug actually occurs in the example project!**" + placeholder: "https://your.reproduction.project/download/url/here" + validations: + required: false + - type: "input" + id: "engine-version" + attributes: + label: "Full engine version" + description: | + Input the full engine version here. + Simply copy the `Initialized sos!engine v (commit -, dirty ) in ms` message here. + placeholder: "Example: sos!engine v1-alpha4 (commit 05b9644eba5263809b6655dabb92669523a95805-develop, dirty true)" + validations: + required: true + - type: "dropdown" + id: "jvm-java" + attributes: + label: "Java version" + description: "Which Java version is your application compiled against?" + options: + - "20 and lower" + - "21" + - "22" + - "23" + validations: + required: true + - type: "input" + id: "os" + attributes: + label: "Operating system" + description: "Name the operating system, version (if applicable) and CPU architecture the error occurs on. This may be some Linux distribution, Android or Windoze on `amd64`/`aarch64`/`ppc64`/etc.." + placeholder: "Example: Debian trixie (amd64)" + validations: + required: true + - type: "markdown" + id: "text-tysm" + attributes: + value: | + Thank you for filling out this bug report. + Please check your answers for *mistaeks* or sensitive information before sending this report. diff --git a/.gitea/issue_template/config.yml b/.gitea/issue_template/config.yml new file mode 100644 index 00000000..f4e4ceb5 --- /dev/null +++ b/.gitea/issue_template/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: "📚 Documentation" + about: "Visit the documentation. Maybe you just skipped something important or just haven't found the page you're looking for yet." + url: "https://engine.staropensource.de" diff --git a/.gitea/issue_template/featurerequest.yml b/.gitea/issue_template/featurerequest.yml new file mode 100644 index 00000000..83cc8ee9 --- /dev/null +++ b/.gitea/issue_template/featurerequest.yml @@ -0,0 +1,54 @@ +name: "✨ Feature Request" +about: "Request a feature to be implemented in the engine." +title: "feat: " +labels: + - "FeatureRequest/New" +body: + - type: "markdown" + id: "text-introduction" + attributes: + value: | + Hey there! Thank you for taking the time to request a feature to us. \ + Before filling any of this out, please think for one minute if the feature is really important and necessary enough to implement in the engine. If you're unsure, continue. \ + Please answer the following questions accurately, or we may not be able to implement the feature as you requested it. \ + \ + **Note: Please check if the same bug report already exists. If not, continue. If so, participate in that one instead. If another issue is similar but not the same, make sure to mention the related issues.** \ + **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.** + **Note: Submitting a feature request will *not* gurantee it's inclusion into the engine. By submitting a feature request, you are at the grace of the community to pick up your suggestion. + - type: "textarea" + id: "feature-description" + attributes: + label: "Feature description" + description: "Explain *what* you want added. Include as many details as possible." + placeholder: "Example: I want to do X in my project, which would simplify doing Y." + 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 explore alternative ways of implementing the feature in the engine (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 engine directly. Include as many details as possible. **Leave empty if it can't simply be solved by creating a subsystem.**" + placeholder: | + Example: + I've considered writing a subsystem for this feature. + Otherwise it would be possible to use with some configuration. + I've also considered using the normal 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 for mistaeks before sending this report. diff --git a/.gitea/issue_template/helprequest.yml b/.gitea/issue_template/helprequest.yml new file mode 100644 index 00000000..111207fb --- /dev/null +++ b/.gitea/issue_template/helprequest.yml @@ -0,0 +1,89 @@ +name: "💬 Help" +about: "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 StarOpenSource Engine. \ + Please answer the following questions accurately, otherwise we may not 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. If another issue is similar but not the same, make sure to mention the related issues.** \ + **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 create a custom LoggerImplementation implementation?" + validations: + required: true + - type: "textarea" + id: "help-log" + attributes: + label: "Log" + description: | + Please insert the ENTIRE log output here, so we can understand the problem at hand. + You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM args) with the default log template. + + *This field can be left empty if the problem you are faciing does not involve/require log output.** + placeholder: "Your log file here..." + value: | + ```plain + Your log file here... + ``` + validations: + required: false + - type: "textarea" + id: "help-snippet" + attributes: + label: "Code snippet" + description: | + Please insert a snippet of the application code which you think is causing the issue. + + **This field can be left empty if the problem you are faciing does not involve/require code.** + value: | + ```java + Your code snippet here... + ``` + validations: + required: false + - type: "input" + id: "engine-version" + attributes: + label: "Full engine version" + description: | + Input the full engine version here. + Simply copy the `Initialized sos!engine v (commit -, dirty ) in ms` message here. + placeholder: "Example: sos!engine v1-alpha4 (commit 05b9644eba5263809b6655dabb92669523a95805-develop, dirty true)" + validations: + required: true + - type: "dropdown" + id: "jvm-java" + attributes: + label: "Java version" + description: "Which Java version is your application compiled against?" + options: + - "20 and lower" + - "21" + - "22" + - "23" + validations: + required: true + - type: "input" + id: "os" + attributes: + label: "Operating system" + description: "Name the operating system, version (if applicable) and CPU architecture the error occurs on. This may be some Linux distribution, Android or Windoze on `amd64`/`aarch64`/`ppc64`/etc.." + placeholder: "Example: Debian trixie (amd64)" + validations: + required: true + - type: "markdown" + id: "text-tysm" + attributes: + value: | + Thank you for filling out this help form. + Please check your answers for *mistaeks* or sensitive information before sending this help request. diff --git a/.gitea/pull_request_template.md b/.gitea/pull_request_template.md new file mode 100644 index 00000000..b1054cc6 --- /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' +--- +