Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Mujtabaa07 authored Jan 2, 2025
2 parents eed0579 + 03c9414 commit 13b447e
Show file tree
Hide file tree
Showing 27 changed files with 1,108 additions and 169 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
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: textarea
attributes:
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: false
- type: textarea
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: textarea
attributes:
label: Any additional information?
description: Any additional information or Is there anything we should know about this bug?
validations:
required: false
- type: dropdown
attributes:
label: What browser are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- 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!
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! 🙏
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
38 changes: 38 additions & 0 deletions .github/workflows/PRs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: PR Auto Comment

on:
pull_request_target:
types: [opened, ready_for_review]

jobs:
pr-comment:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Comment on PR
uses: actions/github-script@v6
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `### Thank you for your contribution! 🎉
#### PR Checklist
- [ ] Tests added/updated
- [ ] Documentation updated
- [ ] Changes follow coding standards
- [ ] Commit messages are clear
#### Next Steps
1. We will review your PR soon
2. Address any requested changes
3. Once approved, your PR will be merged
Need help? Check our [Contributing Guide](https://github.com/Mujtabaa07/coffeeShop/blob/main/CONTRIBUTING.md)
Happy coding! 💻`
})
38 changes: 38 additions & 0 deletions .github/workflows/auto-comment-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: 'Auto Comment on PR Merge'

on:
pull_request_target:
types: [closed]

permissions:
pull-requests: write

jobs:
auto_comment:
runs-on: ubuntu-latest
if: github.event.pull_request.merged == true

steps:
- uses: actions/checkout@v3

- name: Create Success Comment
uses: actions/github-script@v6
with:
github-token: ${{ secrets.COFFEE_SHOP_GITHUB_TOKEN }}
script: |
const message = `### 🎉 Congratulations on Your Merged PR!
Thank you @${context.payload.pull_request.user.login} for your contribution!
#### What's Next?
- 🌟 Consider contributing to other issues
- 📚 Check our [Contributing Guidelines](https://github.com/Mujtabaa07/coffeeShop/blob/main/CONTRIBUTING.md) for more ways to help
Keep up the fantastic work! 🚀`;
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: message
});
Loading

0 comments on commit 13b447e

Please sign in to comment.