Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
mansi066 committed Jan 2, 2025
2 parents a1d8be4 + c55b90a commit 92e16ed
Show file tree
Hide file tree
Showing 27 changed files with 618 additions and 260 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ body:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Microsoft Edge
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/Doc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: "📚 Documentation Update"
description: "Help us improve our documentation"
title: "[DOCS] "
labels: ["documentation", "needs-triage"]

body:
- type: markdown
attributes:
value: |
Thanks for helping improve our documentation! 📖
Please fill out the information below to help us understand your suggestion better.
- type: textarea
id: current_docs
attributes:
label: "Current Documentation"
description: "What's currently in the documentation that needs to be updated?"
placeholder: "Example: The installation guide is missing steps for Windows setup..."
validations:
required: true

- type: textarea
id: suggested_change
attributes:
label: "Suggested Changes"
description: "What changes would you like to see?"
placeholder: "Example: Add Windows-specific installation steps..."
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: "Screenshots or Examples"
description: "Add screenshots or examples if applicable"
placeholder: "Drag and drop images here..."

- type: dropdown
id: doc_type
attributes:
label: "Documentation Type"
options:
- Installation Guide
- API Reference
- Tutorials
- README
- Other
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: "Contribution Agreement"
options:
- label: "I have searched existing issues and this is not a duplicate"
required: true
- label: "I have read the contributing guidelines"
required: true
- label: "I would like to work on fixing this documentation"
required: false

- type: markdown
attributes:
value: |
---
⭐ Thank you for helping make our documentation better!
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature-Request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: "✨ Feature Request"
description: "Suggest a new feature to enhance our Coffee Shop"
title: "[FEATURE] "
labels: ["enhancement", "triage-needed"]

body:
- type: markdown
attributes:
value: |
# Feature Request
Thanks for taking the time to suggest a new feature!
Please fill out the information below to help us understand your suggestion better.
- type: textarea
id: problem
attributes:
label: "Problem Statement"
description: "What problem does this feature solve?"
placeholder: "I'm always frustrated when..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: "Proposed Solution"
description: "Describe the solution you'd like"
placeholder: "It would be great if..."
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: "Alternative Solutions"
description: "What alternatives have you considered?"
placeholder: "Another approach could be..."

- type: textarea
id: screenshots
attributes:
label: "Screenshots or Mockups"
description: "Add any relevant screenshots, mockups or examples"
placeholder: "Drag and drop images here..."

- type: dropdown
id: priority
attributes:
label: "Priority"
options:
- High
- Medium
- Low
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: "Contribution Guidelines"
options:
- label: "I have searched [existing issues](https://github.com/Mujtabaa07/coffeeShop/issues) and this is not a duplicate"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Mujtabaa07/coffeeShop/blob/main/CONTRIBUTING.md)"
required: true
- label: "I would like to implement this feature"
required: false

- type: markdown
attributes:
value: |
---
💡 Thank you for contributing to make our Coffee Shop better!
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/document.yml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/feature_request.yml

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/general_issues.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: "🤔 General Issue"
description: "Submit a general question, suggestion or issue"
title: "[GENERAL] "
labels: ["triage-needed"]

body:
- type: markdown
attributes:
value: |
# General Issue Template
Thanks for taking the time to fill out this issue! Please provide as much information as possible.
- type: dropdown
id: category
attributes:
label: "Category"
description: "What type of issue is this?"
options:
- Question
- Suggestion
- Problem
- Other
validations:
required: true

- type: textarea
id: description
attributes:
label: "Description"
description: "What would you like to share or ask?"
placeholder: "Provide details about your issue, question, or suggestion..."
validations:
required: true

- type: textarea
id: additional
attributes:
label: "Additional Context"
description: "Add any other context, screenshots, or relevant information"
placeholder: "Add any additional details here..."

- type: dropdown
id: impact
attributes:
label: "Impact Level"
options:
- High
- Medium
- Low
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: "Contribution Guidelines"
options:
- label: "I have searched [existing issues](https://github.com/Mujtabaa07/coffeeShop/issues) to avoid duplicates"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Mujtabaa07/coffeeShop/blob/main/CONTRIBUTING.md)"
required: true
- label: "I would like to help resolve this issue"
required: false

- type: markdown
attributes:
value: |
---
Thank you for contributing to our project! 🙏
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/other.yml

This file was deleted.

35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/refactor_code.yml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Give a X on, which is applicable
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] Any dependent changes have been merged and published in downstream modules
Loading

0 comments on commit 92e16ed

Please sign in to comment.