Merge pull request #1 from GenomicDataInfrastructure/ART-3129

feat: #53 Add issues and pr templates

.github/ISSUE_TEMPLATE/bug_template.yml

@@ -0,0 +1,103 @@
+# SPDX-FileCopyrightText: 2024 PNED G.I.E.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: "🐞 Bug Report"
+description: Report the issue you are having
+title: "🐞 BUG REPORT"
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## 🐞 Bug Report 
+
+        We're sorry to hear you're encountering an issue! 🛠️ Your detailed report is crucial in helping us identify and resolve problems quickly.
+
+        Please use this form to provide as much information as possible about the issue. This not only helps us in prompt troubleshooting but also ensures we keep improving the user experience.
+
+        **Quick Links for Your Reference**
+        - [📜 Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)
+        - [👥 Contribution Guide](https://github.com/GenomicDataInfrastructure/gdi-userportal-frontend/graphs/contributors)
+
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: 🔄 Duplicate Check
+      description: Please confirm that this issue has not been reported before.
+      options:
+        - label: "I have searched both open and closed issues and found no similar reports."
+          required: true
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: "🔍 What Happened?"
+      description: "Provide a clear and concise description of the issue."
+      placeholder: "Describe the issue in detail. What did you see or experience?"
+
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: "👣 Steps to Reproduce"
+      description: "Detail the steps to replicate the problem."
+      placeholder: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Scroll down to '...'
+        4. Notice the error
+
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "📸 Screenshots"
+      description: "If applicable, add screenshots to help illustrate the issue."
+      placeholder: "Drag & drop, paste, or select a file to upload screenshots."
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: "📋 Logs"
+      description: "Share any relevant log output or error messages."
+
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: "🌐 Affected Browsers"
+      description: "Which browsers did you encounter the issue on?"
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Opera
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: "💻 Operating System"
+      description: "Which operating system(s) is affected?"
+      multiple: true
+      options: 
+        - Windows
+        - Linux
+        - macOS
+
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: "🤝 Want to Contribute to the Fix?"
+      description: "Indicate if you're interested in contributing to fixing this issue."
+      multiple: false
+      options:
+        - "No, I can't contribute."
+        - "Yes, I'd like to help fix this."
+      default: 0
+
+  - type: textarea
+    id: anything-else
+    attributes:
+      label: "ℹ️ Additional Information"
+      description: "Share any other relevant information or context."
+      placeholder: "System information, version details, etc."

.github/ISSUE_TEMPLATE/feature_template.yml

@@ -0,0 +1,70 @@
+# SPDX-FileCopyrightText: 2024 PNED G.I.E.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: "✨ Feature Request"
+description: Suggest an idea for this project
+title: "✨ FEATURE: "
+labels: ["feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## ✨ Feature Request
+
+        Your ideas are the spark that ignites innovation! 🚀 Thank you for taking the time to share your thoughts and suggestions with us.
+
+        Whether it's a small tweak or a big revolution, every feature request is a step towards making our project more powerful and user-friendly. Please fill out the form below with as much detail as possible to help us understand your vision.
+
+        **Before you start:**
+        - 🔍 Ensure your feature hasn't already been suggested by searching existing issues.
+        - 🎯 Clearly describe the use-case, benefits, and necessity of your proposed feature.
+        - 🔄 Consider if this feature should be broadly implemented or better suited as a plugin.
+
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: "🔍 Prior Research"
+      description: "Boost the chances of your feature being accepted by ensuring it hasn't been suggested before."
+      options:
+        - label: "I have searched both 'open' and 'closed' issues to confirm this is not a duplicate."
+          required: true
+
+  - type: textarea
+    id: feature-summary
+    attributes:
+      label: "✏️ Feature Summary"
+      description: "Provide a clear and concise description of the proposed feature."
+      placeholder: "I envision a feature that..."
+
+  - type: textarea
+    id: problem-solution
+    attributes:
+      label: "🎯 Problem & Solution"
+      description: "Detail the problem at hand and how your feature offers a solution."
+      placeholder: "The challenge is... and this feature addresses it by..."
+
+  - type: textarea
+    id: alternatives-considered
+    attributes:
+      label: "🔄 Alternatives Considered"
+      description: "Share any alternative solutions or features you have considered."
+      placeholder: "Alternative approaches include..."
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: "📚 Additional Context"
+      description: "Provide any more context, links, or screenshots that can paint a clearer picture of your feature."
+      placeholder: "Here's more context..."
+
+  - type: dropdown
+    id: assignee
+    attributes:
+      label: "🛠️ Willing to Contribute?"
+      description: "Are you interested in contributing to the implementation of this feature?"
+      multiple: false
+      options:
+        - "No, I am just suggesting"
+        - "Yes, I'd like to contribute"
+      default: 0

.github/ISSUE_TEMPLATE/story_template.yml

@@ -0,0 +1,51 @@
+# SPDX-FileCopyrightText: 2024 PNED G.I.E.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+name: "📝 User Story"
+description: Provide a detailed user story including what needs to be done, why, the tasks involved, and the acceptance criteria.
+title: "📝 USER STORY: "
+labels: ["user-story"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## 🚀 User Story
+
+        🌟 A compelling user story does more than outline requirements; it paints a picture of progress, impact, and transformation. 🎨
+
+        Please take a moment to fill in each section with detail and care. Your thorough input enables us to align our efforts closely with our users' real-world needs and expectations.
+
+  - type: textarea
+    id: what
+    attributes:
+      label: "🎯 What? (Story Description)"
+      description: "Describe the desired outcome or goal of this story."
+
+  - type: textarea
+    id: why
+    attributes:
+      label: "💡 Why? (Justification)"
+      description: "Explain the value or benefit this story brings to the project or its users."
+      placeholder: "This is important because..."
+
+  - type: textarea
+    id: tasks
+    attributes:
+      label: "🔨 Tasks (Breakdown)"
+      description: "List the tasks or steps needed to achieve the desired outcome of this story."
+      placeholder: "Tasks involved might include..."
+
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: "✅ Acceptance Criteria"
+      description: "Define clear and testable criteria to determine when this story is completed."
+      placeholder: "This story is considered done when..."
+
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: "➕ Additional Information"
+      description: "Add any extra notes, links, or screenshots that can help illustrate your story. Your thoroughness can light the way to success!"
+      placeholder: "Think outside the box, every detail adds depth..."

.github/pull_request_template.md

@@ -0,0 +1,34 @@
+<!-- SPDX-FileCopyrightText: 2024 PNED G.I.E. -->
+
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+## 🚀 Pull Request Checklist
+
+- **Title:** 
+  - `[ ]` A brief, descriptive title for the changes.
+
+- **Description:**
+  - `[ ]` Provide a clear and concise description of your pull request, including the purpose of the changes and the approach you've taken.
+
+- **Context:**
+  - `[ ]` Why are these changes necessary? What problem do they solve? Link any related issues.
+
+- **Changes:**
+  - `[ ]` List the major changes you've made, ideally organized by commit or feature.
+
+- **Testing:**
+  - `[ ]` Describe how the changes have been tested. Include any relevant details about the testing environment and the test cases.
+
+- **Screenshots (if applicable):**
+  - `[ ]` If your changes are visual, include screenshots to help explain your changes.
+
+- **Additional Information:**
+  - `[ ]` Add any other information that might be useful for reviewers, such as considerations, discussions, or dependencies.
+
+- **Checklist:**
+  - `[ ]` I have checked that my code adheres to the project's style guidelines and that my code is well-commented.
+  - `[ ]` I have performed self-review of my own code and corrected any misspellings.
+  - `[ ]` I have made corresponding changes to the documentation (if applicable).
+  - `[ ]` My changes generate no new warnings or errors.
+  - `[ ]` 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.