|
| 1 | +--- |
| 2 | + |
| 3 | +name: 📚 Documentation or README.md issue report |
| 4 | +description: Report an issue in the project's documentation or README.md file. |
| 5 | +title: "[Docs]: " |
| 6 | +labels: ["type: documentation", "type: maintenance"] |
| 7 | + |
| 8 | +assignees: |
| 9 | + - lotyp |
| 10 | + |
| 11 | +body: |
| 12 | + - type: markdown |
| 13 | + attributes: |
| 14 | + value: 📚 **Documentation Issue Report** |
| 15 | + |
| 16 | + - type: textarea |
| 17 | + id: documentation-bug-description |
| 18 | + attributes: |
| 19 | + label: Describe the bug |
| 20 | + description: Provide a clear and concise description of what the error or issue is in the documentation. |
| 21 | + placeholder: Explain the issue with the documentation... |
| 22 | + validations: |
| 23 | + required: true |
| 24 | + |
| 25 | + - type: textarea |
| 26 | + id: steps-to-reproduce |
| 27 | + attributes: |
| 28 | + label: To Reproduce |
| 29 | + description: | |
| 30 | + Please provide steps to reproduce the error in the documentation: |
| 31 | + 1. Navigate to the section or URL where the error occurs... |
| 32 | + 2. Specify the misleading or incorrect information... |
| 33 | + 3. Suggest what is expected if applicable... |
| 34 | + placeholder: | |
| 35 | + 1. URL or Section... |
| 36 | + 2. Misleading information... |
| 37 | + 3. Expected correction... |
| 38 | + validations: |
| 39 | + required: true |
| 40 | + |
| 41 | + - type: textarea |
| 42 | + id: media-prove |
| 43 | + attributes: |
| 44 | + label: Media prove |
| 45 | + description: If applicable, add screenshots or videos to better illustrate the issue with the documentation. |
| 46 | + placeholder: Upload files or paste links here... |
| 47 | + validations: |
| 48 | + required: false |
| 49 | + |
| 50 | + - type: textarea |
| 51 | + id: desired-solution |
| 52 | + attributes: |
| 53 | + label: Describe the solution you would like |
| 54 | + description: Describe what changes or improvements you would like to see in the documentation. |
| 55 | + placeholder: Describe the desired changes or improvements... |
| 56 | + validations: |
| 57 | + required: true |
| 58 | + |
| 59 | + - type: textarea |
| 60 | + id: additional-context |
| 61 | + attributes: |
| 62 | + label: Additional context |
| 63 | + description: Add any other context or additional information that could help clarify the documentation issue. |
| 64 | + placeholder: Provide any additional context here... |
| 65 | + validations: |
| 66 | + required: false |
| 67 | + |
| 68 | + - type: markdown |
| 69 | + attributes: |
| 70 | + value: | |
| 71 | + 📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one. |
| 72 | + We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines: |
| 73 | + - [Code of Conduct](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/CODE_OF_CONDUCT.md) |
| 74 | + - [Contribution Guidelines](https://github.com/wayofdev/laravel-package-tpl/blob/master/.github/CONTRIBUTING.md) |
| 75 | +
|
| 76 | +... |
0 commit comments