|
| 1 | +name: Bug Report |
| 2 | +description: Something isn't working as expected |
| 3 | +labels: [bug] |
| 4 | +body: |
| 5 | +- type: markdown |
| 6 | + attributes: |
| 7 | + value: "## Thank you for contributing to Swift-DocC!" |
| 8 | +- type: markdown |
| 9 | + attributes: |
| 10 | + value: | |
| 11 | + Before you submit your issue, please complete each textarea |
| 12 | + below with the relevant details for your bug, and complete |
| 13 | + the steps in the checklist |
| 14 | +- type: textarea |
| 15 | + attributes: |
| 16 | + label: Description |
| 17 | + description: | |
| 18 | + A short description of the incorrect behavior. |
| 19 | + If you think this issue has been recently introduced and did not occur in an |
| 20 | + earlier version, please note that. If possible, include the last version that |
| 21 | + the behavior was correct in addition to your current version. |
| 22 | + validations: |
| 23 | + required: true |
| 24 | +- type: checkboxes |
| 25 | + attributes: |
| 26 | + label: Checklist |
| 27 | + options: |
| 28 | + - label: If possible, I've reproduced the issue using the `main` branch of this package. |
| 29 | + required: false |
| 30 | + - label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/apple/swift-docc/issues). |
| 31 | + required: true |
| 32 | +- type: textarea |
| 33 | + attributes: |
| 34 | + label: Expected Behavior |
| 35 | + description: Describe what you expected to happen. |
| 36 | + validations: |
| 37 | + required: false |
| 38 | +- type: textarea |
| 39 | + attributes: |
| 40 | + label: Actual behavior |
| 41 | + description: Describe or copy/paste the behavior you observe. |
| 42 | + validations: |
| 43 | + required: false |
| 44 | +- type: textarea |
| 45 | + attributes: |
| 46 | + label: Steps To Reproduce |
| 47 | + description: | |
| 48 | + Explanation of how to reproduce the incorrect behavior. |
| 49 | + This could include a reduced version of your documentation bundle, |
| 50 | + or a link to the documentation (or code) that is exhibiting the issue. |
| 51 | + placeholder: | |
| 52 | + 1. In this environment... |
| 53 | + 2. With this config... |
| 54 | + 3. Run '...' |
| 55 | + 4. See error... |
| 56 | + validations: |
| 57 | + required: false |
| 58 | +- type: textarea |
| 59 | + attributes: |
| 60 | + label: Swift-DocC Version Information |
| 61 | + description: | |
| 62 | + examples: |
| 63 | + - **Swift-DocC version:** `5.6.0` for example, or a commit hash. |
| 64 | + - **Swift Compiler version:** Output from `swiftc --version`. |
| 65 | + value: | |
| 66 | + - Swift-DocC version: |
| 67 | + - Swift Compiler version: |
| 68 | + render: markdown |
| 69 | + validations: |
| 70 | + required: false |
0 commit comments