added issue and pr templates

JiyaGupta-cs · Feb 19, 2024 · 06a1bc8 · 06a1bc8
1 parent 5afeae1
commit 06a1bc8
Show file tree

Hide file tree

Showing 6 changed files with 266 additions and 0 deletions.
diff --git a/.github/workflows/Issue_templates/bug_report.yml b/.github/workflows/Issue_templates/bug_report.yml
@@ -0,0 +1,48 @@
+_name: Bug 🐞
+description: Report an issue to help us improve the project.
+title: "[Bug] <write a small description here>"
+body:
+  - type: textarea
+    id: description
+    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
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Please add screenshots if applicable.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I have checked the existing issues."
+          required: true
+
+        - label: "I follow [Contributing Guidelines](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CONTRIBUTING_GUIDELINES.md) of this project."
+          required: true
+
+        - label: "I am a IWOC'24 contributor."
+          required: false
+
+        - label: "I am a JWOC'24 contributor."
+          required: false
+
+        - label: "I am a SWOC'24 contributor."
+          required: false
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)"
+      options:
+        - label: I agree to follow this project's "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)".
+          required: true
diff --git a/.github/workflows/Issue_templates/doc_report.yml b/.github/workflows/Issue_templates/doc_report.yml
@@ -0,0 +1,46 @@
+name: Documentation Request 📃
+description: Change regarding improving the docs to be more accessible
+title: "[Docs]"
+body:
+  - type: textarea
+    attributes:
+      label: Category of documentation update
+      description: |
+        What category does this change fall under. For example Typo error, New category addition, Rephrasing the sentences, fixing broken links etc.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Describe the change you think might work
+      description: Please describe the change & need of change in atmost detail possible.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I have checked the existing issues."
+          required: true
+
+        - label: "I follow [Contributing Guidelines](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CONTRIBUTING_GUIDELINES.md) of this project."
+          required: true
+
+        - label: "I am a IWOC'24 contributor."
+          required: false
+
+        - label: "I am a JWOC'24 contributor."
+          required: false
+
+        - label: "I am a SWOC'24 contributor."
+          required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)"
+      options:
+        - label: I agree to follow this project's "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)".
+          required: true
diff --git a/.github/workflows/Issue_templates/feature_request.yml b/.github/workflows/Issue_templates/feature_request.yml
@@ -0,0 +1,48 @@
+name: Feature Request 💡
+description: Have any new idea or new feature? Please suggest!
+title: "[Feature] <write a small description here>"
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of any alternative solution or features you've considered.
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: Please add screenshots if applicable.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I have checked the existing issues."
+          required: true
+
+        - label: "I follow [Contributing Guidelines](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CONTRIBUTING_GUIDELINES.md) of this project."
+          required: true
+
+        - label: "I am a IWOC'24 contributor."
+          required: false
+
+        - label: "I am a JWOC'24 contributor."
+          required: false
+
+        - label: "I am a SWOC'24 contributor."
+          required: false
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)"
+      options:
+        - label: I agree to follow this project's "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)".
+          required: true
diff --git a/.github/workflows/Issue_templates/others.yml b/.github/workflows/Issue_templates/others.yml
@@ -0,0 +1,52 @@
+name: Other 🤔
+description: Use this for any other issues. PLEASE do not create blank issues
+title: "[Other]"
+body:
+  - type: markdown
+    attributes:
+      value: "# Other issue"
+
+  - type: textarea
+    id: issuedescription
+    attributes:
+      label: What would you like to share?
+      description: Provide a clear and concise explanation of your issue.
+    validations:
+      required: true
+
+  - type: textarea
+    id: extrainfo
+    attributes:
+      label: Additional information
+      description: Is there anything else we should know about this issue?
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I have checked the existing issues."
+          required: true
+
+        - label: "I follow [Contributing Guidelines](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CONTRIBUTING_GUIDELINES.md) of this project."
+          required: true
+
+        - label: "I am a IWOC'24 contributor."
+          required: false
+
+        - label: "I am a JWOC'24 contributor."
+          required: false
+
+        - label: "I am a SWOC'24 contributor."
+          required: false
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)"
+      options:
+        - label: I agree to follow this project's "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)".
+          required: true
diff --git a/.github/workflows/Issue_templates/style.yml b/.github/workflows/Issue_templates/style.yml
@@ -0,0 +1,42 @@
+name: Style Changing Request 👯‍♂️
+description: Suggest a style design
+title: '[Style]'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this template!
+  - type: textarea
+    id: style-idea
+    attributes:
+      label: What's the style idea?
+      placeholder: Add descriptions
+      value: 'We need to improve'
+
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I have checked the existing issues."
+          required: true
+
+        - label: "I follow [Contributing Guidelines](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CONTRIBUTING_GUIDELINES.md) of this project."
+          required: true
+
+        - label: "I am a IWOC'24 contributor."
+          required: false
+
+        - label: "I am a JWOC'24 contributor."
+          required: false
+
+        - label: "I am a SWOC'24 contributor."
+          required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)"
+      options:
+        - label: I agree to follow this project's "[Code of Conduct](https://github.com/Rakesh9100/Beautiify/blob/main/.github/CODE_OF_CONDUCT.md)".
+          required: true
diff --git a/.github/workflows/PR_template.md b/.github/workflows/PR_template.md
@@ -0,0 +1,30 @@
+# Fixes Issue🛠️
+
+<!-- Example: Closes #31 -->
+
+Closes #
+
+# Description👨‍💻
+
+<!--Please include a summary of the change and which issue is fixed.List any dependencies that are required for this change.-->
+
+# Type of change📄
+
+<!--Please delete options that are not relevant.-->
+
+- [] Bug fix (non-breaking change which fixes an issue)
+- [] New feature (non-breaking change which adds functionality)
+
+# How this has been tested✅
+
+<!--Please describe the tests that you ran to verify your changes.-->
+
+# Checklist✅
+
+- [] 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 added demonstration in the form of GIF/video file
+- [] I am an Open Source Contributor
+
+# Screenshots/GIF📷