From 38df17f885b78fae26c14fc376d4e0533694e192 Mon Sep 17 00:00:00 2001 From: ezDecode Date: Sat, 5 Oct 2024 19:39:26 +0530 Subject: [PATCH] Added the Templates for Pull-Request and Issue --- .github/ISSUE_TEMPLATE/bug.yml | 72 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/document.yml | 44 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 58 +++++++++++++++++ .github/pull_request_template.md | 47 ++++++++++++++ .github/workflows/greetings.yaml | 15 +++++ .github/workflows/static.yml | 43 ------------- 6 files changed, 236 insertions(+), 43 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/document.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/greetings.yaml delete mode 100644 .github/workflows/static.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..f22721d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,72 @@ +name: 🐞 Bug +description: Report an issue to help us improve the project. +title: "[BUG] " +labels: ["bug", "goal: fix", "priority: medium"] +assignees: [] +body: + - type: textarea + id: description + attributes: + label: Description + description: Briefly describe the issue, what you tried, and what didn't work. + placeholder: "Describe the issue in detail..." + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Provide steps to reproduce the issue. + placeholder: "1. Go to...\n2. Click on...\n3. See error..." + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: Describe what you expected to happen. + placeholder: "What should have happened?" + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual Behavior + description: Describe what actually happened. + placeholder: "What actually happened?" + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional Information + description: Any other details or information about the bug. + placeholder: "Any other details..." + validations: + required: false + - type: dropdown + id: browser + attributes: + label: Browser + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - Other + validations: + required: true + - type: checkboxes + id: no-duplicate-issues + attributes: + label: Checklist + options: + - label: "I have checked the existing [issues](https://github.com/GarimaSingh0109/WasteManagment/issues)." + required: true + - label: "I have read the [Code Of Conduct](https://github.com/GarimaSingh0109/WasteManagment?tab=coc-ov-file)" + required: true + - label: "The changes don't break the code" + required: true + - label: "Please attach screenshots and videos of the development work once done" + required: true diff --git a/.github/ISSUE_TEMPLATE/document.yml b/.github/ISSUE_TEMPLATE/document.yml new file mode 100644 index 0000000..4756d9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/document.yml @@ -0,0 +1,44 @@ +name: "Documentation 📋" +description: "Use this form to present your suggestions on how to improve our documentation" +title: "[DOCS] " +labels: ["documentation", "goal: enhancement"] + +body: + - type: textarea + id: docs_description + attributes: + label: "Issue Description" + description: "Please provide a brief summary of the documentation issue you are experiencing or would like to address." + validations: + required: true + + - type: textarea + id: screenshots_examples_docs + attributes: + label: "Screenshots or Examples (if applicable)" + description: "Please include relevant screenshots or examples to help illustrate the problem." + + - type: textarea + id: proposed_solution_docs + attributes: + label: "Proposed Solution (optional)" + description: "If you have a proposed solution for the documentation issue, please provide it here. This can be helpful for speeding up the resolution process." + + - type: checkboxes + id: terms_checklist_docs + attributes: + label: "Checklist" + description: "By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/GarimaSingh0109/WasteManagment?tab=coc-ov-file)" + options: + - label: "I have checked the existing [issues](https://github.com/GarimaSingh0109/WasteManagment/issues)." + required: true + - label: "The changes don't break the code." + required: true + - label: "Please attach the screenshots and video of the development work once it is done." + required: true + + - type: textarea + id: additional_comments + attributes: + label: "Additional Comments (optional)" + description: "Any additional comments or information you would like to provide." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..8b2bfbe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,58 @@ +name: Feature Request 💡 +description: Have any new idea or new feature for WasteManagement? Please suggest! +title: "[Feature] " +labels: ["enhancement", "goal: addition", "priority: high"] +assignees: [] +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the feature or alternative solutions you've considered. + validations: + required: true + - type: textarea + id: motivation + attributes: + label: Motivation + description: Explain why this feature would be useful and how it benefits the project. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable. + validations: + required: false + - type: textarea + id: additional_context + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. + validations: + required: false + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: "I have checked the existing [issues](https://github.com/GarimaSingh0109/WasteManagment/issues)." + required: true + - label: "I have read the [Code Of Conduct](https://github.com/GarimaSingh0109/WasteManagment?tab=coc-ov-file)." + required: true + - label: "The changes don't break the code." + required: true + - label: "I will attach screenshots and videos of the development work once it is done." + required: true + - type: dropdown + id: priority + attributes: + label: Priority + description: Select the priority level for this feature request. + options: + - "Low" + - "Medium" + - "High" + validations: + required: true \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a82e06c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,47 @@ + + +## Issues Identification + +Closes: #(issue number) + +## Description + +### Summary +Provide a brief description of what this pull request does and why it is needed. + +### Details +Include any detailed information about the changes in this pull request. + +## Types of Changes + +_Please check the boxes that apply_ + +- [ ] Bugfix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update (Documentation content changed) +- [ ] Other (please describe): + +## Checklist + +_Please check the boxes that apply_ + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own 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 +- [ ] My changes do not break the current system and pass all existing test cases +- [ ] 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 + +## Screenshots + +If applicable, please attach screenshots of the changes made to the user interface. + +## Additional Information + +Please provide any other information that is relevant to this pull request. + + \ No newline at end of file diff --git a/.github/workflows/greetings.yaml b/.github/workflows/greetings.yaml new file mode 100644 index 0000000..b489280 --- /dev/null +++ b/.github/workflows/greetings.yaml @@ -0,0 +1,15 @@ +name: Greetings 🐦‍🔥 +on: [pull_request_target, issues] + +jobs: + greeting: + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + steps: + - uses: actions/first-interaction@v1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + issue-message: "Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible." + pr-message: "Thank you, ${{ github.actor }}, for creating this pull request and contributing to WasteManagement! 💗\n\n The maintainers will review this Pull Request and provide feedback as soon as possible! 😇\nWe appreciate your patience and contribution, Keep up the great work! 😀" diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml deleted file mode 100644 index f2c9e97..0000000 --- a/.github/workflows/static.yml +++ /dev/null @@ -1,43 +0,0 @@ -# Simple workflow for deploying static content to GitHub Pages -name: Deploy static content to Pages - -on: - # Runs on pushes targeting the default branch - push: - branches: ["main"] - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - -# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. -# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. -concurrency: - group: "pages" - cancel-in-progress: false - -jobs: - # Single deploy job since we're just deploying - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Setup Pages - uses: actions/configure-pages@v5 - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - # Upload entire repository - path: '.' - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4