Skip to content

Commit

Permalink
maintenance: update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubtobiasz committed Nov 20, 2024
1 parent a7e69b4 commit 248d492
Show file tree
Hide file tree
Showing 6 changed files with 304 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/01-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Feature Request
description: Suggest an idea for this project
title: "💡 "
labels: ["triage needed"]
assignees:
- jakubtobiasz
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a new feature!
- type: textarea
id: description
attributes:
label: Description 📄
description: Provide a big picture of what and why should be done.
placeholder: As a [type of user], I want [goal] so that [benefit]...
validations:
required: true

- type: textarea
id: small-wins
attributes:
label: Small Wins 🏆
description: Break your need into smaller steps and requirements
placeholder: |
- [ ] Feature X is implemented
- [ ] Feature Y is implemented
- [ ] Feature Z is implemented
validations:
required: true

- type: textarea
id: tips
attributes:
label: Tips & Research 💡
description: Share any research, references, or examples
placeholder: |
- Similar implementations: ...
- Reference links: ...
- Technical considerations: ...
validations:
required: false
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/02-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Bug Report
description: File a bug report
title: "🐛 "
labels: ["triage needed"]
type: "Bug"
assignees:
- jakubtobiasz
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: Description 📄
description: A clear and concise description of what the bug is.
placeholder: Tell us what happened...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction Steps 🚶
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. See error
```php
// Add code if applicable
```
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior 👀
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: dropdown
id: php-version
attributes:
label: PHP Version
description: What version of PHP are you using?
options:
- PHP 8.2
- PHP 8.1
- PHP 8.0
- Other (specify in additional context)
validations:
required: true

- type: textarea
id: context
attributes:
label: Additional Context 💡
description: Add any other context about the problem here (environment, configurations, etc.)
validations:
required: false
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/03-epic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Epic
description: Create a new epic to track large features or projects
title: "🏔️ "
type: "Epic"
assignees: []
body:
- type: markdown
attributes:
value: |
Use this template to create a new epic that will contain multiple related issues.
- type: textarea
id: objective
attributes:
label: Epic Objective 🎯
description: What is the main goal of this epic?
placeholder: This epic aims to...
validations:
required: true

- type: textarea
id: scope
attributes:
label: Scope 📊
description: Define what is in and out of scope for this epic
placeholder: |
In scope:
- Feature X
- Feature Y
Out of scope:
- Feature Z
validations:
required: true

- type: textarea
id: deliverables
attributes:
label: Key Deliverables 📦
description: List the main deliverables or features that will be part of this epic
placeholder: |
1. [ ] Component A implementation
2. [ ] Integration with B
3. [ ] Documentation update
validations:
required: true

- type: textarea
id: dependencies
attributes:
label: Dependencies 🔄
description: List any dependencies or related epics
placeholder: |
- Depends on Epic #123
- Blocks Epic #456
validations:
required: false

- type: textarea
id: technical-considerations
attributes:
label: Technical Considerations 🛠️
description: Any technical details or architecture decisions that need to be considered
validations:
required: false
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/04-task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Task
description: Create a new task that is part of an epic
title: ""
type: "Task"
assignees: []
body:
- type: markdown
attributes:
value: |
Create a new task that will be part of an epic. Tasks should be achievable within a reasonable timeframe and have clear acceptance criteria.
- type: textarea
id: description
attributes:
label: Task Description 📄
description: Clear description of what needs to be done
placeholder: |
What needs to be done...
Why it needs to be done...
validations:
required: true

- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria ✨
description: List the conditions that must be satisfied for this task to be completed
placeholder: |
- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3
validations:
required: true

- type: textarea
id: implementation-details
attributes:
label: Implementation Details 🛠️
description: Technical details about how this should be implemented
placeholder: |
- Technical approach
- Required changes
- Potential impacts
validations:
required: false

- type: textarea
id: dependencies
attributes:
label: Dependencies 🔄
description: List any dependencies or related tasks
placeholder: |
- Depends on Task #456
- Should be done before Task #789
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context 💡
description: Any other relevant information
validations:
required: false
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/05-subtask.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Subtask
description: Create a new subtask that is part of a larger task
title: "📎 "
type: "Task"
assignees: []
body:
- type: markdown
attributes:
value: |
Create a new subtask that will be part of a larger task. Subtasks should be small, specific, and independently completable.
- type: textarea
id: description
attributes:
label: Task Description 📄
description: Clear description of what needs to be done
placeholder: |
What needs to be done...
Why it needs to be done...
validations:
required: true

- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria ✨
description: List the conditions that must be satisfied for this task to be completed
placeholder: |
- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3
validations:
required: true

- type: textarea
id: implementation-details
attributes:
label: Implementation Details 🛠️
description: Technical details about how this should be implemented
placeholder: |
- Technical approach
- Required changes
- Potential impacts
validations:
required: false

- type: textarea
id: dependencies
attributes:
label: Dependencies 🔄
description: List any dependencies or related tasks
placeholder: |
- Depends on Task #456
- Should be done before Task #789
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional Context 💡
description: Any other relevant information
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false

0 comments on commit 248d492

Please sign in to comment.