generated from it-at-m/oss-repository-en-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #97 from it-at-m/maint/93-add-issue-templates
📝 Add new issue templates
- Loading branch information
Showing
7 changed files
with
377 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| name: 🐞 Bug report | ||
| description: Report a bug to help the project improve. | ||
| title: "[Bug] " | ||
| labels: ["Type: Bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| To expedite issue processing, please search open and closed issues before submitting a new one. | ||
| Please read our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| - type: markdown | ||
| attributes: | ||
| value: "## General" | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Bug description | ||
| description: A clear and concise description of what the bug is | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expectation | ||
| attributes: | ||
| label: Expected behaviour | ||
| description: A clear and concise description of what you expected to happen | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction-steps | ||
| attributes: | ||
| label: Steps for reproduction | ||
| description: Detailed list of steps for reproducing the bug | ||
| placeholder: | | ||
| 1. Use x argument / navigate to | ||
| 2. Fill this information | ||
| 3. Go to... | ||
| 4. See error | ||
| validations: | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Version and environment information" | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Affected version | ||
| description: Version of the project the bug is concerned to | ||
| placeholder: e.g. 1.0.2 | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: component | ||
| attributes: | ||
| label: Affected component | ||
| multiple: true | ||
| description: Name(s) of the affected components(s) (if applicable) | ||
| options: | ||
| - refarch-gateway | ||
| - refarch-integrations | ||
| - refarch-cli | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| id: last-working-version | ||
| attributes: | ||
| label: Last working version (optional) | ||
| description: Last version of the project where the bug was not present | ||
| placeholder: e.g. 1.0.1 | ||
| validations: | ||
| required: false | ||
| - type: dropdown | ||
| id: os | ||
| attributes: | ||
| label: Operating system | ||
| multiple: true | ||
| description: Operating systems the bug occurs on (optional, only if applicable) | ||
| options: | ||
| - Windows | ||
| - macOS | ||
| - Linux | ||
| - Other | ||
| validations: | ||
| required: false | ||
| - type: dropdown | ||
| id: browser | ||
| attributes: | ||
| label: Browser | ||
| multiple: true | ||
| description: Browsers the bug occurs on (optional, only if applicable) | ||
| options: | ||
| - Firefox | ||
| - Chrome | ||
| - Safari | ||
| - Edge | ||
| - Other | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Extras" | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output (optional) | ||
| description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
| render: shell | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: Screenshots (optional) | ||
| description: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Additional context (optional) | ||
| description: Additional context (references, links, ...) that might be helpful | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Confirmations" | ||
| - type: checkboxes | ||
| id: check-duplicate | ||
| attributes: | ||
| label: No duplicate | ||
| description: By submitting this issue, you confirm to have checked for duplicate issues beforehand. | ||
| options: | ||
| - label: I confirm that this issue is not a duplicate | ||
| required: true | ||
| - type: checkboxes | ||
| id: conduct | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| name: ✨ Feature request | ||
| description: Suggest an idea or possible new feature for this project. | ||
| title: "[Feature] " | ||
| labels: ["Type: Feature"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this feature request! | ||
| To expedite issue processing, please search open and closed issues before submitting a new one. | ||
| Please read our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| - type: markdown | ||
| attributes: | ||
| value: "## General" | ||
| - type: dropdown | ||
| id: component | ||
| attributes: | ||
| label: Relevant component | ||
| multiple: true | ||
| description: Name(s) of the affected component(s) (if applicable) | ||
| options: | ||
| - refarch-gateway | ||
| - refarch-integrations | ||
| - refarch-cli | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: problem-description | ||
| attributes: | ||
| label: Problem description (optional) | ||
| description: A clear and concise description of what the problem is (if related to problem) | ||
| placeholder: | | ||
| e.g. I'm always frustrated when ... | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: desired-solution | ||
| attributes: | ||
| label: Desired solution | ||
| description: A clear and concise description of what you want to happen | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Considered alternatives (optional) | ||
| description: A clear and concise description of any alternative solutions or features you've considered | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Extras" | ||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Additional context (optional) | ||
| description: Additional context (references, links, screenshots, ...) that might be helpful | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Confirmations" | ||
| - type: checkboxes | ||
| id: check-duplicate | ||
| attributes: | ||
| label: No duplicate | ||
| description: By submitting this issue, you confirm to have checked for duplicate issues beforehand. | ||
| options: | ||
| - label: I confirm that this issue is not a duplicate | ||
| required: true | ||
| - type: checkboxes | ||
| id: conduct | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| name: ⚙ Maintenance work | ||
| description: Suggest useful or required maintenance work for this project. | ||
| title: "[Maintenance] " | ||
| labels: ["Type: Maintenance"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this maintenance work issue! | ||
| To expedite issue processing, please search open and closed issues before submitting a new one. | ||
| Please read our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| - type: markdown | ||
| attributes: | ||
| value: "## General" | ||
| - type: dropdown | ||
| id: component | ||
| attributes: | ||
| label: Relevant component | ||
| multiple: true | ||
| description: Name(s) of the affected component(s) (if applicable) | ||
| options: | ||
| - refarch-gateway | ||
| - refarch-integrations | ||
| - refarch-cli | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: problem-description | ||
| attributes: | ||
| label: Problem description (optional) | ||
| description: A clear and concise description of what the problem is (if related to problem) | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: desired-solution | ||
| attributes: | ||
| label: Desired solution | ||
| description: A clear and concise description of what you want to happen | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Considered alternatives (optional) | ||
| description: A clear and concise description of any alternative solutions you've considered | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Extras" | ||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Additional context (optional) | ||
| description: Additional context (references, links, screenshots, ...) that might be helpful | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Confirmations" | ||
| - type: checkboxes | ||
| id: check-duplicate | ||
| attributes: | ||
| label: No duplicate | ||
| description: By submitting this issue, you confirm to have checked for duplicate issues beforehand. | ||
| options: | ||
| - label: I confirm that this issue is not a duplicate | ||
| required: true | ||
| - type: checkboxes | ||
| id: conduct | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| name: 📄 Documentation change | ||
| description: Suggest a documentation change for this project. | ||
| title: "[Documentation] " | ||
| labels: ["Type: Documentation"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this documentation change issue! | ||
| To expedite issue processing, please search open and closed issues before submitting a new one. | ||
| Please read our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| - type: markdown | ||
| attributes: | ||
| value: "## General" | ||
| - type: dropdown | ||
| id: component | ||
| attributes: | ||
| label: Relevant documentation | ||
| multiple: true | ||
| description: Affected documentation parts | ||
| options: | ||
| - refarch-gateway | ||
| - refarch-integrations | ||
| - refarch-cli | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: problem-description | ||
| attributes: | ||
| label: Problem description (optional) | ||
| description: A clear and concise description of what the problem is (if related to problem) | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: desired-solution | ||
| attributes: | ||
| label: Desired solution | ||
| description: A clear and concise description of what you want to happen | ||
| validations: | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Extras" | ||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Additional context (optional) | ||
| description: Additional context (references, links, screenshots, ...) that might be helpful | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: "## Confirmations" | ||
| - type: checkboxes | ||
| id: check-duplicate | ||
| attributes: | ||
| label: No duplicate | ||
| description: By submitting this issue, you confirm to have checked for duplicate issues beforehand. | ||
| options: | ||
| - label: I confirm that this issue is not a duplicate | ||
| required: true | ||
| - type: checkboxes | ||
| id: conduct | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/main/.github/CODE_OF_CONDUCT.md). | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true |
Oops, something went wrong.