Add Templates for Issues and PR

algosup · Jan 13, 2025 · d1af4ce · d1af4ce
1 parent 1e6b50e
commit d1af4ce
Show file tree

Hide file tree

Showing 3 changed files with 235 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,84 @@
+name: Bug Report
+description: Report a bug error in the code.
+title: "🐞 [Bug]: "
+labels: ["bug", "error"]
+projects: ["algosup/2024-2025-project-3-quickest-path-team-7"]
+assignees:
+  - Pierre2103
+  - HiNett
+body:
+  - type: markdown
+    attributes:
+      value: |
+        🚨 **Oops! There's a bug in the code.**  
+        Thank you for taking the time to report it. Please provide as much detail as possible so we can fix the issue quickly. 🛠️
+  - type: input
+    id: date
+    attributes:
+      label: 📅 Bug Report Date
+      description: Specify the date when the bug was reported.
+      placeholder: "YYYY-MM-DD"
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: 🐞 Bug Description
+      description: What happened? What did you expect to happen?
+      placeholder: Provide a clear and concise description of the problem.
+      value: "A bug occurred!"
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: 🔄 Steps to Reproduce
+      description: Provide the steps to reproduce the issue.
+      placeholder: e.g., "1. Do this. 2. Do that. 3. See the error."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: 📜 Relevant Log Output
+      description: Paste any relevant log output. This will be formatted as code.
+      render: shell
+  - type: dropdown
+    id: environment
+    attributes:
+      label: 🖥️ Environment
+      description: Provide details about your environment.
+      options:
+        - Windows
+        - macOS
+        - Linux
+        - Other
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: 🔢 Version
+      description: Select the version where the bug occurred.
+      options:
+        - v0.0.3
+        - v0.0.2
+        - v0.0.1
+    validations:
+      required: true
+  - type: input
+    id: branch
+    attributes:
+      label: 🌿 Branch
+      description: Enter the branch where the bug occurred.
+      placeholder: Enter the branch name.
+      validations:
+        required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: ℹ️ Additional Information
+      description: Add any other details or context that could help us resolve the issue.
+      placeholder: Provide additional details here.
+      validations:
+        required: false
diff --git a/.github/ISSUE_TEMPLATE/typo_report.yml b/.github/ISSUE_TEMPLATE/typo_report.yml
@@ -0,0 +1,90 @@
+name: Typography Report
+description: Report a typography error in project documents.
+title: "✏️ [Typography]: "
+labels: ["documentation", "typography"]
+projects: ["algosup/2024-2025-project-3-quickest-path-team-7"]
+assignees:
+  - Pierre2103
+  - HiNett
+body:
+  - type: markdown
+    attributes:
+      value: |
+        📝 **Thank you for reporting a typography issue!**  
+        Clear and detailed reports help us maintain high-quality project documentation. Please fill in the form below.
+  - type: input
+    id: date
+    attributes:
+      label: 📅 Report Date
+      description: Specify the date when this issue was reported.
+      placeholder: "YYYY-MM-DD"
+    validations:
+      required: true
+  - type: dropdown
+    id: document-type
+    attributes:
+      label: 📄 Document Type
+      description: Which document contains the typo?
+      options:
+        - Functional Specification
+        - Technical Specification
+        - Test Plan
+        - User Manual
+        - Other
+    validations:
+      required: true
+  - type: input
+    id: document-type-other
+    attributes:
+      label: 🆕 Other Document Type
+      description: If "Other," please specify the document type.
+      placeholder: Enter the document type.
+    validations:
+      required: false
+  - type: dropdown
+    id: document-author
+    attributes:
+      label: ✍️ Document Author
+      description: Who wrote the document?
+      options:
+        - Elone DELILLE
+        - Abderrazaq MAKRAN
+        - Guillaume DERAMCHI
+        - Pierre GORIN
+        - Benoît DE KEYN
+        - Axel DAVID
+        - Tino GABET
+    validations:
+      required: true
+  - type: textarea
+    id: typo-location
+    attributes:
+      label: 📌 Typo Location
+      description: Where exactly is the typo? (Line, section, or paragraph)
+      placeholder: Provide precise details.
+    validations:
+      required: true
+  - type: textarea
+    id: error
+    attributes:
+      label: ❌ Error Description
+      description: What is the typo?
+      placeholder: Describe the error.
+    validations:
+      required: true
+  - type: textarea
+    id: correction
+    attributes:
+      label: ✅ Suggested Correction
+      description: What is the suggested correction?
+      placeholder: Provide the corrected text.
+    validations:
+      required: true
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: ℹ️ Additional Information
+      description: Add any additional details or context that might help us address the issue.
+      placeholder: Additional details here.
+    validations:
+      required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE/merge_pull_request.yml b/.github/PULL_REQUEST_TEMPLATE/merge_pull_request.yml
@@ -0,0 +1,61 @@
+name: Merge Branches
+description: Propose merging changes from one branch into another.
+title: "🔀 Merge [source_branch] into [target_branch]"
+labels: ["merge"]
+projects: ["algosup/2024-2025-project-3-quickest-path-team-7"]
+assignees:
+  - Pierre2103
+  - HiNett
+body:
+  - type: markdown
+    attributes:
+      value: |
+         🔀 **Thank you for initiating a merge!**  
+         Merging branches is a critical step in ensuring the codebase stays clean and functional. Please provide the necessary details below.  
+         ⚠️ **Remember:** Ensure all tests pass and conflicts are resolved before proceeding.
+  - type: input
+    id: date
+    attributes:
+      label: 📅 Merge Date
+      description: Specify the date when this merge is being proposed.
+      placeholder: "YYYY-MM-DD"
+    validations:
+      required: true
+  - type: textarea
+    id: merge-purpose
+    attributes:
+      label: 📝 Merge Purpose
+      description: What is the purpose of this merge? Is it to finalize a feature, resolve a conflict, or integrate updates?
+      placeholder: "Explain why this merge is necessary."
+    validations:
+      required: true
+  - type: textarea
+    id: branch-changes
+    attributes:
+      label: 🔄 Branch Changes
+      description: Summarize the key changes introduced in the branch being merged.
+      placeholder: e.g., "1. Added X. 2. Updated Y. 3. Fixed Z."
+    validations:
+      required: true
+  - type: textarea
+    id: merge-risks
+    attributes:
+      label: ⚠️ Potential Merge Risks
+      description: Identify any risks, such as conflicts or regressions, that might arise from this merge.
+      placeholder: e.g., "Risk of conflicts in file A, regression in feature B."
+    validations:
+      required: false
+  - type: checkboxes
+    id: merge-checklist
+    attributes:
+      label: ✅ Merge Checklist
+      description: Verify that the following steps are completed before proceeding with the merge.
+      options:
+        - label: 🟢 Code conflicts have been resolved
+          required: true
+        - label: 👀 Code was reviewed and approved by peers
+          required: true
+        - label: ✅ All tests pass without errors
+          required: true
+        - label: 📚 Documentation is updated, if applicable
+          required: false