GitHub: Improved issue templates (#16354)

Co-authored-by: 0x5BFA <[email protected]>
Co-authored-by: Yair <[email protected]>

Author: 3 people

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -4,6 +4,13 @@ type: 'Bug'
 title: 'Bug: '
 body:
 
+  # Tip to warn of checking for existing issues
+  - type: markdown
+    attributes:
+      value: |
+        > [!TIP]
+        > Have you checked for similar issues? There's a possibility the bug you are experiencing has already been reported. Please do a thorough search before creating a new issue.
+
   # Description
   - type: textarea
     attributes:
@@ -24,16 +31,6 @@ body:
     validations:
       required: true
 
-  # Requirements
-  - type: textarea
-    attributes:
-      label: Requirements
-      description: describe the expected behavior (eg. Fix crash that occurs when...). If left blank, the issue will likely be closed without discussion.
-      value: |
-        - e.g. Fix crash that occurs when...
-    validations:
-      required: true
-
   # Files Version
   - type: input
     id: files_version
@@ -54,7 +51,7 @@ body:
     validations:
       required: true
 
-    # User ID
+  # User ID
   - type: input
     id: user_id
     attributes:
@@ -64,6 +61,15 @@ body:
     validations:
       required: false
 
+  # Note that the user should always upload the report rather than pasting it.
+  - type: markdown
+    attributes:
+      value: |
+        > [!IMPORTANT]
+        > Please **upload** the log file rather than pasting it here.
+        >
+        > Feel free to remove sensitive information such as your usernames or drive names.
+
   # Log File
   - type: textarea
     attributes:

.github/ISSUE_TEMPLATE/code_quality_issue.yml

@@ -3,18 +3,31 @@ description: Create a code quality issue to help Files keep a clean codebase
 type: 'Code quality'
 title: 'Code Quality: '
 body:
+
+  # Tip to warn of checking for existing issues
+  - type: markdown
+    attributes:
+      value: |
+        > [!TIP]
+        > Have you checked for similar code quality issues? There's a possibility your suggestion is already being tracked. Please do a thorough search before creating a new issue.
+
+  # Issue body
   - type: textarea
     attributes:
       label: Description
       description: A clear and concise description of what the code quality issue is.
     validations:
       required: true
+
+  # Related code
   - type: textarea
     attributes:
       label: Concerned code
       description: A list of the different files and/or areas of the code concerned by the issue.
     validations:
       required: true
+
+  # Gains
   - type: textarea
     attributes:
       label: Gains
@@ -25,6 +38,8 @@ body:
         - eg. Clarifying the responsibility of class C.
     validations:
       required: true
+
+  # Requirements
   - type: textarea
     attributes:
       label: Requirements
@@ -33,6 +48,8 @@ body:
         - eg. Using a specific design pattern.
         - eg. Separating Interface I into three new interfaces I1, I2 and I3.
         - eg. Regrouping the duplicated process into a new helper.
+
+  # Remarks
   - type: textarea
     attributes:
       label: Comments

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -4,6 +4,13 @@ type: 'Feature request'
 title: 'Feature: '
 body:
 
+  # Tip to warn of checking for existing issues
+  - type: markdown
+    attributes:
+      value: |
+        > [!TIP]
+        >Have you checked for similar feature requests? There's a possibility your suggestion is already being tracked. Please do a thorough search before creating a new issue.
+
   # Description
   - type: textarea
     attributes: