Skip to content

Add more issue templates #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Documentation
description: Request changes to documentation
title: "[Documentation] <brief description>"
labels: [documentation]
assignees: []

body:
- type: textarea
id: location
attributes:
label: Where is the documentation issue?
description: Please provide a link or describe the section of the documentation that needs attention.
validations:
required: true

- type: textarea
id: problem
attributes:
label: What is the problem?
description: Explain what's wrong (typo, unclear instructions, outdated info, etc.).
validations:
required: true

- type: textarea
id: suggested_change
attributes:
label: Suggested fix or improvement
description: If you have a suggestion for how to fix the issue, please describe it here.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-synchronization/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Feature Request
description: Suggest a new feature or enhancement
description: Propose a new feature or enhancement
title: "[Feature] <brief description>"
labels: [enhancement]
assignees: []
Expand Down
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Maintenance
description: Suggest internal improvements unrelated to features or bugs
title: "[Maintenance] <brief description>"
labels: []
assignees: []

body:
- type: textarea
id: area
attributes:
label: What area needs maintenance?
description: Specify what part of the project you want to improve.
validations:
required: true

- type: textarea
id: reason
attributes:
label: Why is this improvement needed?
description: Explain the benefit (e.g. performance, test coverage, code quality, build speed).
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed solution
description: If you have a suggestion for how to fix the issue, please describe it here.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-synchronization/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Question
description: Ask a question or request clarification
title: "[Question] <brief description>"
labels: [question]
assignees: []

body:
- type: markdown
attributes:
value: |
### Thanks for asking a question!
> [!Important]
> Please consider using [Discussions](https://github.com/fetch-rewards/swift-synchronization/discussions) to ask your question. There, you can receive answers from maintainers as well as community members. While we do provide this form for submitting questions, we prefer to reserve issues for things that need to be fixed, changed, or added. If you are sharing feedback, asking for help or opinions, or looking to brainstorm ideas with other members of the community, please use [Discussions](https://github.com/fetch-rewards/swift-synchronization/discussions).

- type: textarea
id: question
attributes:
label: What is your question?
description: Please be clear and specific.
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have searched existing [Issues](https://github.com/fetch-rewards/swift-synchronization/issues) and [Discussions](https://github.com/fetch-rewards/swift-synchronization/discussions).
required: true
- label: This is not a bug report or feature request.
required: true

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fetch-rewards/swift-synchronization/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true