Skip to content

Commit

Permalink
docs: issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
lotyp committed Apr 18, 2024
1 parent e3de369 commit 8c71408
Show file tree
Hide file tree
Showing 8 changed files with 426 additions and 12 deletions.
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---

name: 🐞 Bug Report
description: Report an issue to help the project improve.
title: '[Bug]: '
labels: ['type: bug']

assignees:
- lotyp

body:
- type: markdown
attributes:
value: 🐞 **Bug Report**

- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: Please provide a clear and detailed description of what the bug is. This helps us understand the issue quickly and look for potential fixes.
placeholder: Explain the bug in as much detail as possible...
validations:
required: true

- type: textarea
id: regression
attributes:
label: Is this a regression?
description: |
Was this functionality working in a previous version?
If yes, please mention the last version in which it worked properly.
Understanding regressions helps prioritize fixes.
placeholder: Yes or No, and details about the last working version...
validations:
required: false

- type: textarea
id: steps-to-reproduce
attributes:
label: To Reproduce
description: |
'Please provide step-by-step instructions that reproduce the issue:
1. Use x argument / navigate to...
2. Fill this information...
3. Go to...
4. See error
placeholder: Detailed steps to reproduce the bug...
validations:
required: true

- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
description: |
Describe what you expected to happen.
Clear expectations help understand the gap between current and desired states.
placeholder: What did you expect to happen instead of the bug?
validations:
required: true

- type: textarea
id: media
attributes:
label: Media prove
description: If applicable, add screenshots or videos to better illustrate the issue. Visual aids can significantly aid in diagnosing problems quicker.
placeholder: Upload files or paste links here...
validations:
required: false

- type: textarea
id: environment
attributes:
label: Your environment
description: |
Provide detailed information about your environment to help us replicate the issue:
* OS: [e.g. Ubuntu]
* PHP version: [e.g. 8.2.2]
* Package version: [e.g. 1.0.0]
* Any relevant environment details
placeholder: List your environment details here...
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Include any other context about the problem here, such as unusual system configurations, previous issues, or possible causes.
placeholder: Any additional information that could help us resolve the issue...
validations:
required: false

- type: markdown
attributes:
value: |
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
- [Code of Conduct](https://github.com/wayofdev/gh-actions/blob/master/.github/CODE_OF_CONDUCT.md)
- [Contribution Guidelines](https://github.com/wayofdev/gh-actions/blob/master/.github/CONTRIBUTING.md)
Additionally, consider joining our discussions on:
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
...
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---

name: 🚀 Feature Request
description: Suggest an idea or possible new feature for this project.
title: '[Feature]: '
labels: ['type: enhancement']

assignees:
- lotyp

body:
- type: markdown
attributes:
value: 🚀 **Feature Request**

- type: textarea
id: problem-related
attributes:
label: Is your feature request related to a problem? Please describe.
description: |
Please provide a clear and detailed description of what the problem is.
For example, 'I'm always frustrated when...'.
This will help us understand the context and the impact of the problem.
placeholder: Describe the problem...
validations:
required: true

- type: textarea
id: desired-solution
attributes:
label: "Describe the solution you'd like"
description: |
What would you like to see happen? Please provide a detailed explanation of the desired feature.
You may include bullet points to outline objectives, key activities, and expected outcomes.
placeholder: |
1. Objective: [What you hope to achieve with this feature]
2. Key Activities: [Steps to implement the feature]
3. Expected Outcome: [Benefits and results of the feature]
validations:
required: true

- type: textarea
id: alternative-solutions
attributes:
label: "Describe alternatives you've considered"
description: |
Are there alternative solutions or features you've considered? Please describe them.
Understanding different possible solutions can help in finding the best path forward.
placeholder: Describe any alternative solutions or workarounds you have considered...
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.
Links to similar features, or visual aids that support your proposal, if applicable.
placeholder: Insert any additional context or links to similar features here...
validations:
required: false

- type: markdown
attributes:
value: |
📛 To ensure a smooth issue processing, please check if a similar feature request has already been submitted before creating a new one.
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
- [Code of Conduct](https://github.com/wayofdev/gh-actions/blob/master/.github/CODE_OF_CONDUCT.md)
- [Contribution Guidelines](https://github.com/wayofdev/gh-actions/blob/master/.github/CONTRIBUTING.md)
Additionally, consider joining our discussions on:
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
...
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/3-failing-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---

name: 🧪 Failing Test
description: Report failing tests or CI jobs.
title: '[Test]: '
labels: ['Type: Test']

assignees:
- lotyp

body:
- type: markdown
attributes:
value: 🧪 **Failing Test**

- type: textarea
id: failing-tests
attributes:
label: Which jobs/test(s) are failing
description: Please specify which CI jobs or tests are failing. Include test names or job identifiers.
placeholder: List the failing jobs or tests here...
validations:
required: true

- type: textarea
id: reason-for-failure
attributes:
label: Reason for failure/description
description: Explain why the test is failing or what might be missing to make it pass. If available, include error messages or output logs.
placeholder: Provide details on why the test is failing, including error logs or output messages...
validations:
required: true

- type: textarea
id: media-prove
attributes:
label: Media prove
description: If applicable, add screenshots, videos, or links to logs that help explain the issue. Visual aids can be very helpful in diagnosing problems.
placeholder: Upload files or paste links here...
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem, such as related issues, recent changes, or environmental specifics that might influence the test outcome.
placeholder: Include any other relevant information that might help understand the issue...
validations:
required: false

- type: markdown
attributes:
value: |
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
- [Code of Conduct](https://github.com/wayofdev/gh-actions/blob/master/.github/CODE_OF_CONDUCT.md)
- [Contribution Guidelines](https://github.com/wayofdev/gh-actions/blob/master/.github/CONTRIBUTING.md)
Additionally, consider joining our discussions on:
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
...
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/4-docs-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---

name: 📚 Documentation or README.md issue report
description: Report an issue in the project's documentation or README.md file.
title: '[Docs]: '
labels: ['type: documentation', 'type: maintenance']

assignees:
- lotyp

body:
- type: markdown
attributes:
value: 📚 **Documentation Issue Report**

- type: textarea
id: documentation-bug-description
attributes:
label: Describe the bug
description: Provide a clear and concise description of what the error or issue is in the documentation.
placeholder: Explain the issue with the documentation...
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: To Reproduce
description: |
Please provide steps to reproduce the error in the documentation:
1. Navigate to the section or URL where the error occurs...
2. Specify the misleading or incorrect information...
3. Suggest what is expected if applicable...
placeholder: |
1. URL or Section...
2. Misleading information...
3. Expected correction...
validations:
required: true

- type: textarea
id: media-prove
attributes:
label: Media prove
description: If applicable, add screenshots or videos to better illustrate the issue with the documentation.
placeholder: Upload files or paste links here...
validations:
required: false

- type: textarea
id: desired-solution
attributes:
label: Describe the solution you would like
description: Describe what changes or improvements you would like to see in the documentation.
placeholder: Describe the desired changes or improvements...
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or additional information that could help clarify the documentation issue.
placeholder: Provide any additional context here...
validations:
required: false

- type: markdown
attributes:
value: |
📛 To ensure a smooth issue processing, please check if a similar bug report has already been submitted before creating a new one.
We highly value your contributions, so please make sure to familiarize yourself with our repository's guidelines:
- [Code of Conduct](https://github.com/wayofdev/gh-actions/blob/master/.github/CODE_OF_CONDUCT.md)
- [Contribution Guidelines](https://github.com/wayofdev/gh-actions/blob/master/.github/CONTRIBUTING.md)
Additionally, consider joining our discussions on:
- [WayOfDev Discord Community](https://discord.gg/CE3TcCC5vr)
...
Loading

0 comments on commit 8c71408

Please sign in to comment.