Skip to content

Commit

Permalink
Merge pull request #42 from Avdhesh-Varshney/issueTemplate
Browse files Browse the repository at this point in the history
Issues Templates Ready
  • Loading branch information
piyushkdas0611 authored Oct 19, 2023
2 parents 8f2cb43 + e4a7eba commit 49ccb29
Show file tree
Hide file tree
Showing 5 changed files with 219 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: ​🐞 Bug
description: Report an issue to help us improve the project.
title: "[BUG] <write a small description here>"
labels: ["bug"]
body:
- type: textarea
attributes:
label: Description
id: description
description: A brief description of the issue or bug you are facing, also include what you tried and what didn't work.
validations:
required: false

- type: textarea
attributes:
label: Screenshots
id: screenshots
description: Please add screenshots if applicable
validations:
required: false

- type: textarea
attributes:
label: Any additional information?
id: extrainfo
description: Any additional information or Is there anything we should know about this bug?
validations:
required: false

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing issues"
required: true

- label: "I have read the [Contributing Guidelines](https://github.com/piyushkdas0611/Profile-Card-Generator/blob/main/CONTRIBUTING.md)"
required: true

- label: "I am willing to work on this issue (optional)"
required: false

- label: "I am a Hacktoberfest 2023 contributor"
required: false
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Documentation request 📃
description: Change regarding improving the docs to be more accessible
title: '[docs]'
labels: ['documentation']
body:
- type: textarea
attributes:
label: Category of documentation update
description: |
What category does this change fall under. For example Typo error, New category addition, Rephrasing the sentences, fixing broken links etc.
validations:
required: true

- type: textarea
attributes:
label: Describe the change you think might work
description: Please describe the change & need of change in atmost detail possible.
validations:
required: false

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing issues"
required: true

- label: "I have read the [Contributing Guidelines](https://github.com/piyushkdas0611/Profile-Card-Generator/blob/main/CONTRIBUTING.md)"
required: true

- label: "I am willing to work on this issue (optional)"
required: false

- label: "I am a Hacktoberfest 2023 contributor"
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request 💡
description: Have any new idea or new feature? Please suggest!
title: "[Feature] <write a small description here>"
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of any alternative solution or features you've considered.
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing issues"
required: true

- label: "I have read the [Contributing Guidelines](https://github.com/piyushkdas0611/Profile-Card-Generator/blob/main/CONTRIBUTING.md)"
required: true

- label: "I am willing to work on this issue (optional)"
required: false

- label: "I am a Hacktoberfest 2023 contributor"
required: false
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Other 🤔
description: Use this for any other issues. PLEASE do not create blank issues
title: "[other]"
labels: ["awaiting triage"]
body:
- type: markdown
attributes:
value: "# Other issue"

- 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: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?
validations:
required: false

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing issues"
required: true

- label: "I have read the [Contributing Guidelines](https://github.com/piyushkdas0611/Profile-Card-Generator/blob/main/CONTRIBUTING.md)"
required: true

- label: "I am willing to work on this issue (optional)"
required: false

- label: "I am a Hacktoberfest 2023 contributor"
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/styles.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: 👯‍♂️ Style Changing Request
description: Suggest a style designs
title: '[style]'
labels: ["enhancement"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this template!
- type: textarea
id: style-idea
attributes:
label: What's the style idea?
placeholder: Add descriptions
value: 'We need to improve'
validations:
required: true

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "Checklist"
options:
- label: "I have checked the existing issues"
required: true

- label: "I have read the [Contributing Guidelines](https://github.com/piyushkdas0611/Profile-Card-Generator/blob/main/CONTRIBUTING.md)"
required: true

- label: "I am willing to work on this issue (optional)"
required: false

- label: "I am a Hacktoberfest 2023 contributor"
required: false

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct

0 comments on commit 49ccb29

Please sign in to comment.