|
| 1 | +# See: |
| 2 | +# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository |
| 3 | +# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms |
| 4 | +# - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/common-validation-errors-when-creating-issue-forms |
| 5 | + |
| 6 | +name: 🔧 Support Request |
| 7 | +description: Get help using this project |
| 8 | +title: "[Support]: " |
| 9 | +labels: ["support"] |
| 10 | +body: |
| 11 | + - type: markdown |
| 12 | + attributes: |
| 13 | + value: | |
| 14 | + Thanks for taking the time to file a support request. |
| 15 | + Please fill out this form as completely as you can. |
| 16 | + - type: checkboxes |
| 17 | + id: preflight |
| 18 | + attributes: |
| 19 | + label: Existing issues |
| 20 | + description: Please search existing issues before raising a new one. |
| 21 | + options: |
| 22 | + - label: I have searched the existing issues |
| 23 | + required: true |
| 24 | + - type: input |
| 25 | + id: summary |
| 26 | + attributes: |
| 27 | + label: Summary |
| 28 | + description: A short summary of the help you need. |
| 29 | + placeholder: e.g. Unable to run make config on macOS |
| 30 | + validations: |
| 31 | + required: true |
| 32 | + - type: textarea |
| 33 | + id: goal |
| 34 | + attributes: |
| 35 | + label: What are you trying to do? |
| 36 | + description: Describe your goal and the outcome you want. |
| 37 | + validations: |
| 38 | + required: true |
| 39 | + - type: textarea |
| 40 | + id: tried |
| 41 | + attributes: |
| 42 | + label: What have you tried so far? |
| 43 | + description: Include commands, config changes, and references you followed. |
| 44 | + validations: |
| 45 | + required: true |
| 46 | + - type: textarea |
| 47 | + id: expected |
| 48 | + attributes: |
| 49 | + label: What did you expect to happen? |
| 50 | + description: If helpful, describe the expected result. |
| 51 | + validations: |
| 52 | + required: false |
| 53 | + - type: textarea |
| 54 | + id: actual |
| 55 | + attributes: |
| 56 | + label: What happened instead? |
| 57 | + description: Describe the result you saw, including errors or warnings. |
| 58 | + validations: |
| 59 | + required: false |
| 60 | + - type: textarea |
| 61 | + id: steps |
| 62 | + attributes: |
| 63 | + label: Steps to reproduce (if relevant) |
| 64 | + description: Provide clear steps if the issue is repeatable. |
| 65 | + placeholder: | |
| 66 | + 1. ... |
| 67 | + 2. ... |
| 68 | + validations: |
| 69 | + required: false |
| 70 | + - type: textarea |
| 71 | + id: environment |
| 72 | + attributes: |
| 73 | + label: Environment |
| 74 | + description: Add relevant details about your setup. |
| 75 | + value: | |
| 76 | + - OS: |
| 77 | + - Tool versions: |
| 78 | + - Runtime: |
| 79 | + render: markdown |
| 80 | + validations: |
| 81 | + required: false |
| 82 | + - type: input |
| 83 | + id: version |
| 84 | + attributes: |
| 85 | + label: Project version or commit |
| 86 | + description: If known, provide a version, tag, or commit SHA. |
| 87 | + placeholder: e.g. v1.2.3 or abc1234 |
| 88 | + validations: |
| 89 | + required: false |
| 90 | + - type: textarea |
| 91 | + id: logs |
| 92 | + attributes: |
| 93 | + label: Relevant command output |
| 94 | + description: Please copy and paste relevant output. This will be formatted as code. |
| 95 | + render: shell |
| 96 | + validations: |
| 97 | + required: false |
| 98 | + - type: textarea |
| 99 | + id: context |
| 100 | + attributes: |
| 101 | + label: Additional context |
| 102 | + description: Add any other context or screenshots that might help. |
| 103 | + validations: |
| 104 | + required: false |
| 105 | + - type: checkboxes |
| 106 | + id: conduct |
| 107 | + attributes: |
| 108 | + label: Code of Conduct |
| 109 | + description: By submitting this issue, you agree to follow this project's Code of Conduct. |
| 110 | + options: |
| 111 | + - label: I agree to follow this project's Code of Conduct |
| 112 | + required: true |
| 113 | + - type: checkboxes |
| 114 | + id: sensitive |
| 115 | + attributes: |
| 116 | + label: Sensitive information |
| 117 | + description: Please do not include PII or PID, or any other sensitive data. See [data safety guidance](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public). |
| 118 | + options: |
| 119 | + - label: I confirm this request does not include PII/PID, or sensitive data |
| 120 | + required: true |
0 commit comments