Skip to content

feat : Add issue and pull request templates for better contribution guidelines #96

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

Closed
wants to merge 2 commits into from
Closed
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
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug report 🐞
description: File a bug report
title: "[Bug] "
labels: bug
body:
- type: checkboxes
id: existing-issue
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: A concise description of what you are experiencing.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add Screenshots
description: Add sufficient Screenshots to explain your issue.
- type: dropdown
id: devices
attributes:
label: On which device are you experiencing this bug?
multiple: true
options:
- MacOS
- Linux
- Chrome
- Windows
- type: checkboxes
id: terms
attributes:
label: Record
options:
- label: "I have read the Contributing Guidelines"
required: true
- label: "I have starred the repository"
required: false
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Feature Request ✨
description: Suggest a feature
title: "[Feature Request] "
labels: enhancement
body:
- type: checkboxes
id: existing-issue
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for this feature.
options:
- label: I have searched the existing issues
required: true
- type: textarea
id: feature-description
attributes:
label: Feature Description
description: Please provide a detailed description of the feature you are requesting.
placeholder: Describe the new feature or enhancement you'd like to see.
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: How would this feature enhance your use of the project?
placeholder: Describe a specific use case or scenario where this feature would be beneficial.
validations:
required: true
- type: textarea
id: benefits
attributes:
label: Benefits
description: What benefits would this feature bring to the project or community?
placeholder: Explain the advantages of implementing this feature.
- type: textarea
id: screenshots
attributes:
label: Add Screenshots
description: If any...
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- High
- Medium
- Low
default: 0
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Record
options:
- label: "I have read the Contributing Guidelines"
required: true
- label: "I have starred the repository"
required: false
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Other
description: Use this for any other issues. Please do NOT create blank issues
title: '[OTHER] write a small description here'
body:
- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true

- type: dropdown
id: browser
attributes:
label: '✨ Browser'
description: 'What browser are you using ?'
options:
- Google Chrome
- Brave
- Arc
- Safari
- Microsoft Edge
- Mozilla Firefox
- Other
validations:
required: true

- type: checkboxes
id: no-duplicate-issues
attributes:
label: 'Checklist 🚀'
options:
- label: "I checked and didn't find similar issue"
required: true

- label: 'I have read the Contributing Guidelines'
required: true

- label: 'I am willing to work on this issue (blank for no).'
required: false

- label: "I have starred the repository"
required: false
61 changes: 61 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: "Pull Request Details"

body:
- type: markdown
attributes:
value: |
## Pull Request Details

- type: input
id: issue_number
attributes:
label: "Issue Number"
description: "If applicable, please provide the related issue number."
placeholder: "Issue #"

- type: checkboxes
id: pr_type
attributes:
label: "PR Type"
description: "Please select the type of PR you are submitting."
options:
- label: "Feature"
value: feature
- label: "Improvement"
value: improvement
- label: "Bug"
value: bug
- label: "New Project"
value: new_project

- type: textarea
id: pr_description
attributes:
label: "PR Description"
description: "Please provide a short description of the changes made in this pull request."

- type: markdown
attributes:
value: |
## Checklist ✅

- type: checkboxes
id: checklist
attributes:
label: "Checklist"
description: "Please check each item that you have completed for this PR:"
options:
- label: "I have read and understood the project's Contribution Guidelines."
value: read_contribution_guidelines
- label: "I have tested my changes to ensure they work as expected."
value: tested_changes
- label: "I have added/updated relevant documentation/screenshots (if applicable)."
value: updated_documentation
- label: "I have included tests (if applicable)."
value: included_tests
- label: "I have labeled the PR appropriately with 'Feature', 'Improvement', 'Bug', or 'New Project'."
value: labeled_pr
- label: "My branch is up to date with the main branch."
value: branch_up_to_date
- label: "The PR has a meaningful title and description."
value: meaningful_title_description
Loading