From 3ed2989a8b2f489450dbf5a1d5fe873df6f47dfe Mon Sep 17 00:00:00 2001 From: Max Theilig Date: Tue, 10 Oct 2023 15:59:38 +0200 Subject: [PATCH] issue and pr template --- .github/ISSUE_TEMPLATE/BUG-REPORT.yml | 76 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml | 72 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/PULL_REQUEST_TEMPLATE.md | 30 +++++++++ 4 files changed, 179 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG-REPORT.yml create mode 100644 .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml new file mode 100644 index 00000000..b06dde60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml @@ -0,0 +1,76 @@ +name: "🐛 Bug Report" +description: Create a new ticket for a bug. +title: "🐛 [BUG] - " +labels: [ + "bug", + "invalid" +] +body: + - type: textarea + id: description + attributes: + label: "Description" + description: Please enter an explicit description of the issue. + placeholder: | + Short and explicit description of the incident... + If you are able to specify, please also select the appropriate label: + - Bug, if something is technically not working, e.g. not compiling. + - Invalid, if something is technically working but does not seem to yield to correct outcome, e.g. 1+1 is 3. + validations: + required: true + - type: input + id: reprod-url + attributes: + label: "Reproduction URL" + description: Please enter the corresponding Simplifier URL (or other, e.g. GitHub) to provide a source for reproduction of the issue. + placeholder: ex. https://simplifier.net/REPO-NAME/RESOURCE-NAME + validations: + required: true + - type: input + id: version + attributes: + label: "Version or Branch" + description: If this bug occures only in a specific version or development branch, please tell us here. + placeholder: ex. Only occurs with ISiK 2.0.4. + validations: + required: false + - type: textarea + id: reprod + attributes: + label: "Reproduction Steps" + description: Please enter a step by step description of the issue. + value: | + + 1. At the interface '....' + 2. With Data '....' + 3. Execute Operation '....' + 4. See error + render: bash + validations: + required: true + - type: textarea + id: logs + attributes: + label: "Stack Trace and Logs" + description: Please copy and paste any relevant stack trace or log output. This will be automatically formatted into code. + render: bash + validations: + required: false + - type: textarea + id: screenshot + attributes: + label: "Screenshots" + description: If applicable, add screenshots to help explain your problem. + value: | + ![DESCRIPTION](LINK.png) + render: bash + validations: + required: false + - type: textarea + id: environment + attributes: + label: "Software and Environment" + description: Please describe the used software and your environment further. + placeholder: ex. I Use dotnet sdk 4.x and Firely Terminal to manage fhir packages + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml new file mode 100644 index 00000000..77974bbb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml @@ -0,0 +1,72 @@ +name: "💡 Feature Request" +description: Create a new ticket for a new feature request +title: "💡 [REQUEST] - <title>" +labels: [ + "question", + "enhancement" +] +body: + - type: input + id: target_date + attributes: + label: "Target Date" + description: When would you need this feature to be available? + placeholder: "MM YYYY" + validations: + required: false + - type: input + id: implementation_pr + attributes: + label: "Implementation PR" + description: In case you already developed the feature yourself, please tell us the corresponding PR. Also, maybe you have seen this feature somewhere else? + placeholder: "Your Pull Request ID or link to a similar PR." + validations: + required: false + - type: textarea + id: reference_issues + attributes: + label: "Reference Issues" + description: Some common issues this feature would address. + placeholder: "Issues IDs and references" + validations: + required: false + - type: textarea + id: summary + attributes: + label: "Summary" + description: Please provide a brief explanation of the feature. + placeholder: | + Describe in a few lines your feature request ... + If you are able to specify, please also select the appropriate label: + - Question, if you would also be fine with more information, on how to address your request, e.g. with a workaround. + - Enhancement, if you are kinda sure your Request is an independent new addition, that could not be achieved otherwise. + validations: + required: true + - type: textarea + id: basic_example + attributes: + label: "Common Examples" + description: Indicate some basic examples of your feature or a common flow in which it would be used. + placeholder: | + In the use case of '...' + The necessary data will flow like '....' + Feature will be used '....' + With the result of '....' + validations: + required: true + - type: textarea + id: drawbacks + attributes: + label: "Drawbacks" + description: What are the drawbacks or mutual impacts of your feature request? + placeholder: Identify the drawbacks and mutual impacts with respect to other features. + validations: + required: true + - type: textarea + id: unadress_question + attributes: + label: "Unadressed questions" + description: What issues or questions still remain unadressed? + placeholder: Identify any unresolved issues or questions. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..81ad2c5b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ +<!--- Provide a general summary of your changes in the Title above --> + +## Description +<!--- Describe your changes in detail --> + +## Motivation and Context +<!--- Why is this change required? What problem does it solve? --> +<!--- If it fixes an open issue, please link to the issue here. --> +<!--- If it full fills an open feature request, please link to the feature request here. --> + +## How has this been tested? +<!--- Please describe in detail how you tested your changes. --> +<!--- Include details of your testing environment, especially --> +<!--- the software you teste your change with. --> +<!--- Are other areas of the specification affected? --> + +## Snippets or Screenshots (if necessary): + +## Types of changes +<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +## Checklist: +<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> +<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> +- [ ] My code follows the code style of this IG / specification. +- [ ] My change requires a change to the documentation or narrative (intend) of the IG. +- [ ] I have already updated the documentation / narrative (intend) accordingly. \ No newline at end of file