Skip to content

Commit

Permalink
changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Mujtabaa07 committed Jan 2, 2025
1 parent 37d0267 commit 4e04756
Show file tree
Hide file tree
Showing 7 changed files with 290 additions and 86 deletions.
67 changes: 16 additions & 51 deletions .github/ISSUE_TEMPLATE/Bug-report.yaml
Original file line number Diff line number Diff line change
@@ -1,67 +1,32 @@
name: 🐛 Bug Report
description: Create a report to help us improve
title: "[BUG] "
labels: ["bug", "triage"]
name: ​🐞 Bug
description: Report an issue to help us improve the project.
title: "[BUG] <write a small description here>"
labels: ["bug", "goal: fix", "priority: medium"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: describe-bug
attributes:
label: Describe the Bug
description: A clear description of what the bug is
placeholder: Tell us what happened...
label: 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: true

required: false
- type: textarea
id: reproduce
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
label: Screenshots
description: Please add screenshots if applicable
validations:
required: true

required: false
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
label: Any additional information?
description: Any additional information or Is there anything we should know about this bug?
validations:
required: true

required: false
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
label: What browser are you seeing the problem on?
multiple: true
options:
- Chrome
- Firefox
- Chrome
- Safari
- Microsoft Edge

- type: input
id: version
attributes:
label: Version
description: What version of our software are you running?
validations:
required: true

- 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
required: true
- Microsoft Edge
71 changes: 60 additions & 11 deletions .github/ISSUE_TEMPLATE/Doc.yaml
Original file line number Diff line number Diff line change
@@ -1,18 +1,67 @@
name: 📚 Documentation
description: Report documentation issues
title: "[Docs]: "
labels: ["documentation"]
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: description
id: current_docs
attributes:
label: Description
description: What needs to be documented?
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: input
id: page-url
- 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:
label: Page URL
description: Which page needs updating?
value: |
---
⭐ Thank you for helping make our documentation better!
64 changes: 51 additions & 13 deletions .github/ISSUE_TEMPLATE/Feature-Request.yaml
Original file line number Diff line number Diff line change
@@ -1,35 +1,73 @@
name: 💡 Feature Request
description: Suggest an idea for this project
name: " Feature Request"
description: "Suggest a new feature to enhance our Coffee Shop"
title: "[FEATURE] "
labels: ["enhancement"]
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: Is your feature request related to a problem?
description: A clear description of what the problem is
placeholder: I'm always frustrated when...
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: Describe the solution
description: What you want to happen
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: Alternatives Considered
description: Any alternative solutions you've considered
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: Code of Conduct
label: "Contribution Guidelines"
options:
- label: I agree to follow this project's Code of Conduct
required: true
- 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](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!
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](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! 🙏
39 changes: 39 additions & 0 deletions .github/pull_request-templet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.


Fixes # (issue)


## Type of change

Please give a X on it which is applicable

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Refactor Code
- [ ] A documentation update
- [ ] Others(mentioned in the issue number)

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

**_Test A Describe here_**

**_Test B Describe here (if Requred)_**

# Screenshots and Videos:

Give screenshots and video of the changes you made

# Checklist:
Give a X on, which is applicable

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] 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
Loading

0 comments on commit 4e04756

Please sign in to comment.