Merge pull request #3 from aviralgarg05/main

Templates and Workflows

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,55 @@
+name: Bug Report 🐞
+description: Reporting for any bug in the project description or algorithm description.
+title: '🐛: '
+labels: ["Up-for-Grabs ✋", "bug 🐛"]
+assignees:
+  - ''
+
+body:
+  - type: textarea
+    id: bug-title
+    attributes:
+      label: Title
+      placeholder: Enter the title of your bug report here.
+    validations:
+      required: true
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug
+      placeholder: Describe the bug you encountered.
+    validations:
+      required: true
+
+  - type: textarea
+    id: changes
+    attributes:
+      label: Changes
+      placeholder: Explain the approach to handle this bug.
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots 📷
+      placeholder: Write N/A if not available.
+    validations:
+      required: false
+
+  - type: textarea
+    id: full-name
+    attributes:
+      label: Full Name
+      placeholder: Enter your full name here.
+    validations:
+      required: true
+
+  - type: textarea
+    id: participant-role
+    attributes:
+      label: Participant Role
+      placeholder: Mention your participant role or N/A (e.g., GSOC, GSSOC, SSOC, JWOC).
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/enhancement_request.yml

@@ -0,0 +1,65 @@
+name: Enhancement Request 🧑‍💻
+description: Submit your enhancement requests for review.
+title: '🧑‍💻: '
+labels: ["Up-for-Grabs ✋", "enhancement 🧑‍💻"]
+assignees:
+  - ''
+
+body:
+  - type: textarea
+    id: enhancement-title
+    attributes:
+      label: Title
+      placeholder: Enter the title of your enhancement request here.
+    validations:
+      required: true
+
+  - type: textarea
+    id: enhancement-aim
+    attributes:
+      label: Enhancement Aim
+      placeholder: Describe the aim of the enhancement.
+    validations:
+      required: true
+
+  - type: textarea
+    id: changes
+    attributes:
+      label: Changes
+      placeholder: Enlist those changes you want to make.
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots 📷
+      placeholder: Write N/A if not available.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: guidelines
+    attributes:
+      label: Guidelines
+      options:
+        - label: "I have read the guidelines"
+          required: true
+        - label: "I have the link to my latest merged PR"
+          required: false
+
+  - type: textarea
+    id: full-name
+    attributes:
+      label: Full Name
+      placeholder: Enter your full name here.
+    validations:
+      required: true
+
+  - type: textarea
+    id: participant-role
+    attributes:
+      label: Participant Role
+      placeholder: Enter your participant role here (e.g., GSOC, GSSOC, SSOC, JWOC).
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,97 @@
+## Pull Request for ml4e 💡
+
+### Requesting to submit a pull request to the PyVerse repository.
+
+---
+
+#### Issue Title
+**Please enter the title of the issue related to your pull request.**  
+*Enter the issue title here.*
+
+- [ ] I have provided the issue title.
+
+---
+
+#### Info about the Related Issue
+**What's the goal of the project?**  
+*Describe the aim of the project.*
+
+- [ ] I have described the aim of the project.
+
+---
+
+#### Name
+**Please mention your name.**  
+*Enter your name here.*
+
+- [ ] I have provided my name.
+
+---
+
+#### GitHub ID
+**Please mention your GitHub ID.**  
+*Enter your GitHub ID here.*
+
+- [ ] I have provided my GitHub ID.
+
+---
+
+#### Email ID
+**Please mention your email ID for further communication.**  
+*Enter your email ID here.*
+
+- [ ] I have provided my email ID.
+
+---
+
+#### Identify Yourself
+**Mention in which program you are contributing (e.g., WoB, GSSOC, SSOC, SWOC).**  
+*Enter your participant role here.*
+
+- [ ] I have mentioned my participant role.
+
+---
+
+#### Closes
+**Enter the issue number that will be closed through this PR.**  
+*Closes: #issue-number*
+
+- [ ] I have provided the issue number.
+
+---
+
+#### Describe the Add-ons or Changes You've Made
+**Give a clear description of what you have added or modified.**  
+*Describe your changes here.*
+
+- [ ] I have described my changes.
+
+---
+
+#### Type of Change
+**Select the type of change:**  
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Code style update (formatting, local variables)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+---
+
+#### How Has This Been Tested?
+**Describe how your changes have been tested.**  
+*Describe your testing process here.*
+
+- [ ] I have described my testing process.
+
+---
+
+#### Checklist
+**Please confirm the following:**  
+- [ ] My code follows the guidelines of this project.
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly wherever it was hard to understand.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] My changes generate no new warnings.
+- [ ] I have added things that prove my fix is effective or that my feature works.
+- [ ] Any dependent changes have been merged and published in downstream modules.

.github/readme_template.md

@@ -0,0 +1,25 @@
+## **PROJECT TITLE**
+
+### 🎯 **Goal**
+
+`Write the main goal of project and what's the purpose of it.`
+
+### 🧾 **Description**
+
+`Brief description about the project.`
+
+### 🧮 **What I had done!**
+
+`Write down the step by step procedure of how project works using points.`
+
+### 📚 **Libraries Needed**
+
+`Add all the libraries needed in this project in points.`
+
+### 📢 **Conclusion**
+
+`What's the conclusion derived from this project.`
+
+### ✒️ **Your Signature**
+
+`Add your name at the end of the file, along with social media handles if applicable!`

.github/workflows/Auto_message_on_pr_open.yml

@@ -0,0 +1,56 @@
+name: Auto Comment on PR Open
+
+on:
+  pull_request_target:
+    types: [opened]
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  comment-on-open:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Add Comment to Opened PR
+      run: |
+        COMMENT=$(cat <<EOF
+        {
+          "body": "👋 Thank you for opening this pull request! We're excited to review your contribution. Please give us a moment, and we'll get back to you shortly!"
+        }
+        EOF
+        )
+        RESPONSE=$(curl -s -o response.json -w "%{http_code}" \
+          -X POST \
+          -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          -H "Accept: application/vnd.github.v3+json" \
+          https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments \
+          -d "$COMMENT")
+        cat response.json
+        if [ "$RESPONSE" -ne 201 ]; then
+          echo "Failed to add comment on PR open"
+          exit 1
+        fi
+
+    - name: Add Reviewer to Pull Request
+      run: |
+        REVIEWERS=$(cat <<EOF
+        {
+          "reviewers": ["aayank13"]
+        }
+        EOF
+        )
+        RESPONSE=$(curl -s -o response.json -w "%{http_code}" \
+          -X POST \
+          -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          -H "Accept: application/vnd.github.v3+json" \
+          https://api.github.com/repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/requested_reviewers \
+          -d "$REVIEWERS")
+        cat response.json
+        if [ "$RESPONSE" -ne 201 ]; then
+          echo "Failed to add reviewer"
+          exit 1
+        fi
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/auto-comment-on-issue-close.yml

@@ -0,0 +1,35 @@
+name: Auto Comment on Issue Close
+
+on:
+  issues:
+    types: [closed]
+
+permissions:
+  issues: write
+
+jobs:
+  comment-on-close:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Add Comment to Closed Issue
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        COMMENT=$(cat <<EOF
+        {
+          "body": "✅ This issue has been closed. Thank you for your contribution!"
+        }
+        EOF
+        )
+        RESPONSE=$(curl -s -o response.json -w "%{http_code}" \
+          -X POST \
+          -H "Authorization: token $GITHUB_TOKEN" \
+          -H "Accept: application/vnd.github.v3+json" \
+          https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/comments \
+          -d "$COMMENT")
+        cat response.json
+        if [ "$RESPONSE" -ne 201 ]; then
+          echo "Failed to add comment on issue close"
+          exit 1
+        fi

.github/workflows/auto-comment-on-issue.yml

@@ -0,0 +1,36 @@
+name: Auto Comment on Issue Open
+
+on:
+  issues:
+    types: [opened]
+
+permissions:
+  issues: write
+
+jobs:
+  comment-on-issue:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Add Comment to Opened Issue
+      run: |
+        COMMENT=$(cat <<EOF
+        {
+          "body": "🙌 Thank you for bringing this issue to our attention! We appreciate your input and will investigate it as soon as possible."
+        }
+        EOF
+        )
+        RESPONSE=$(curl -s -o response.json -w "%{http_code}" \
+          -X POST \
+          -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          -H "Accept: application/vnd.github.v3+json" \
+          https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/comments \
+          -d "$COMMENT")
+        cat response.json
+        if [ "$RESPONSE" -ne 201 ]; then
+          echo "Failed to add comment on issue open"
+          exit 1
+        fi
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+