Skip to content

Commit

Permalink
[Feature] Improve GitHub Issue Template Guidelines Placement
Browse files Browse the repository at this point in the history
Relocated guidelines section in GitHub issue templates to improve user experience:

- Moved guidelines checkbox section below the first content field
- Maintained all existing guideline requirements
- Reduced friction in issue creation workflow
- Ensured clear visibility of contribution guidelines
- Implemented in all issue templates (bug, feature, documentation)

Rationale:
- Current placement interrupts natural issue reporting flow
- New placement allows more intuitive template progression
- Keeps all compliance checks intact
  • Loading branch information
PPeitsch committed Dec 27, 2024
1 parent ef00a57 commit 2382aaf
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 32 deletions.
21 changes: 11 additions & 10 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,6 @@ body:
value: |
Thanks for taking the time to fill out this bug report!
Please include the ⚡ emoji at the start of your title if you've read our contributing guidelines.
- type: checkboxes
id: terms
attributes:
label: Guidelines
description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/pkynetics/blob/main/.github/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Contributing Guidelines
required: true
- label: I have searched for similar issues before creating this one
required: true
- type: input
id: version
Expand Down Expand Up @@ -107,3 +97,14 @@ body:
placeholder: "Dependency versions, environment details, related issues, etc."
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Guidelines
description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/pkynetics/blob/main/.github/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Contributing Guidelines
required: true
- label: I have searched for similar issues before creating this one
required: true
21 changes: 11 additions & 10 deletions .github/ISSUE_TEMPLATE/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,6 @@ body:
value: |
Thanks for helping us improve our documentation!
Please include the ⚡ emoji at the start of your title if you've read our contributing guidelines.
- type: checkboxes
id: terms
attributes:
label: Guidelines
description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/pkynetics/blob/main/.github/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Contributing Guidelines
required: true
- label: I have checked that this issue hasn't been reported before
required: true
- type: dropdown
id: type
Expand Down Expand Up @@ -69,3 +59,14 @@ body:
placeholder: Add any other relevant information here
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Guidelines
description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/pkynetics/blob/main/.github/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Contributing Guidelines
required: true
- label: I have checked that this issue hasn't been reported before
required: true
25 changes: 13 additions & 12 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,6 @@ body:
value: |
Thanks for taking the time to suggest a new feature!
Please include the ⚡ emoji at the start of your title if you've read our contributing guidelines.
- type: checkboxes
id: terms
attributes:
label: Guidelines
description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/pkynetics/blob/main/.github/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Contributing Guidelines
required: true
- label: I have searched for similar feature requests
required: true
- label: I understand that this is a request and implementation is not guaranteed
required: true
- type: textarea
id: problem
Expand Down Expand Up @@ -73,3 +61,16 @@ body:
placeholder: Technical details, API design, etc.
validations:
required: false

- type: checkboxes
id: terms
attributes:
label: Guidelines
description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/PPeitsch/pkynetics/blob/main/.github/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Contributing Guidelines
required: true
- label: I have searched for similar feature requests
required: true
- label: I understand that this is a request and implementation is not guaranteed
required: true

0 comments on commit 2382aaf

Please sign in to comment.