cuhacking · JeremyFriesenGitHub · Nov 3, 2024 · Oct 20, 2024 · Oct 20, 2024 · Oct 20, 2024
@@ -0,0 +1,76 @@
+name: Bug issue
+description: Report a bug affecting cuHacking 2025 (includes website, portal and docs)
+title: '[BUG]: description-of-issue'
+labels:
+  - bug
+body:
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Search checkbox
+      description: Insufficiently described issues will be closed, so please provide as much information as possible
+      options:
+        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A brief description of the issue
+    validations:
+      required: true
+  - type: textarea
+    id: str
+    attributes:
+      label: Steps to reproduce
+      description: A series of steps to reproduce the issue
+      value: |-
+        1.
+        2.
+        3.
+    validations:
+      required: true
+  - type: textarea
+    id: result
+    attributes:
+      label: Actual result
+      description: What happened
+      placeholder: include screenshots if needed
+    validations:
+      required: true
+  - type: textarea
+    id: expectation
+    attributes:
+      label: Expected result
+      description: What should've happened
+      placeholder: include screenshots if needed
+    validations:
+      required: true
+  - type: dropdown
+    id: reproduces
+    attributes:
+      label: Reproduces how often
+      multiple: false
+      options:
+        - Easily reproduced
+        - Intermittent issue
+        - No steps to reproduce
+      default: 0
+    validations:
+      required: true
+  - type: checkboxes
+    id: reproducibility
+    attributes:
+      label: Reproducibility
+      description: Does this issue occur...
+      options:
+        - label: in Safari?
+        - label: in Firefox?
+        - label: in Chrome?
+        - label: for mobile devices?
+        - label: for tablet devices?
+        - label: for desktop devices?
+  - type: textarea
+    id: misc
+    attributes:
+      label: Miscellaneous information
+      description: Any additional information, related issues, extra QA steps, configuration or data that might be necessary to reproduce the issue
-  - type: textarea
-    id: misc
-    attributes:
-      label: Miscellaneous information
-      description: Any additional information, related issues, extra QA steps, configuration or data that might be necessary to reproduce the issue
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment Information
+      description: Please provide specific details about your environment
+      value: |-
+        - OS and Version:
+        - Browser and Version:
+        - Device Type:
+        - Screen Resolution (if UI-related):
+    validations:
+      required: true
+  - type: textarea
+    id: misc
+    attributes:
+      label: Miscellaneous information
+      description: Any additional information, related issues, extra QA steps, configuration or data that might be necessary to reproduce the issue
-  - type: textarea
-    id: misc
-    attributes:
-      label: Miscellaneous information
-      description: Any additional information, related issues, extra QA steps, configuration or data that might be necessary to reproduce the issue
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment Information
+      description: Please provide specific details about your environment
+      value: |-
+        - OS and Version:
+        - Browser and Version:
+        - Device Type:
+        - Screen Resolution (if UI-related):
+    validations:
+      required: true
+  - type: textarea
+    id: misc
+    attributes:
+      label: Miscellaneous information
+      description: Any additional information, related issues, extra QA steps, configuration or data that might be necessary to reproduce the issue
@@ -0,0 +1,68 @@
+name: Architecture Decision Record
+description: Record a design decision
+title: '[ADR]: description'
+body:
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Search checkbox
+      description: Insufficiently described issues will be closed, so please provide as much information as possible
-      label: Search checkbox
-      description: Insufficiently described issues will be closed, so please provide as much information as possible
+      label: Pre-submission Checklist
+      description: Before submitting, please ensure your ADR meets these requirements:
+        - Clearly states the architectural problem
+        - Provides concrete technical details
+        - Includes implementation considerations
+        - Documents impact on the system
-      label: Search checkbox
-      description: Insufficiently described issues will be closed, so please provide as much information as possible
+      label: Pre-submission Checklist
+      description: Before submitting, please ensure your ADR meets these requirements:
+        - Clearly states the architectural problem
+        - Provides concrete technical details
+        - Includes implementation considerations
+        - Documents impact on the system
+      options:
+        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
+  - type: dropdown
+    id: platforms
+    attributes:
+      label: Platforms
+      multiple: true
+      options:
+        - all
+        - Website
+        - Docs
+        - Portal
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: A brief description of what the issue of the design decision is
+    validations:
+      required: true
+  - type: textarea
+    id: decision
+    attributes:
+      label: Decision
+      description: A brief description of the architectural decision taken
+    validations:
+      required: true
+  - type: textarea
+    id: comparative_table
+    attributes:
+      label: Comparative Table of Technologies
+      description: |-
+        Create a table comparing the different technologies that were considered and show pros and cons for specific use cases. You can copy the template for a table here:
+
+        ```bash
+        | Use Case | Tech 1 | Tech 2 |
+        |----------|--------|--------|
+        | Use Case 1 |        |        |
+        | Use Case 2 |        |        |
+        | Use Case 3 |        |        |
+        ```
+  - type: textarea
+    id: solution
+    attributes:
+      label: Solution Summary
+      description: A summary of the solution of this decision
+      placeholder: |-
+        What is there to do next?
+        What features need to be implemented?
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternative Options
+      description: Are there any alternative options that were considered?
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Alternative Options
-      description: Are there any alternative options that were considered?
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternative Options
+      description: List all alternative options that were considered, including:
+        - Brief description of each alternative
+        - Reasons for not choosing them
+        - Trade-offs and constraints
+    validations:
+      required: true
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Alternative Options
-      description: Are there any alternative options that were considered?
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternative Options
+      description: List all alternative options that were considered, including:
+        - Brief description of each alternative
+        - Reasons for not choosing them
+        - Trade-offs and constraints
+    validations:
+      required: true
@@ -0,0 +1,52 @@
+name: Feature Request
+description: Request a new feature
+title: 'feat(scope-of-issue): description'
+labels:
+  - enhancement
+body:
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Search checkbox
+      description: Insufficiently described issues will be closed, so please provide as much information as possible
+      options:
+        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
-  - type: checkboxes
-    id: search
-    attributes:
-      label: Search checkbox
-      description: Insufficiently described issues will be closed, so please provide as much information as possible
-      options:
-        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Search checkbox
+      description: Insufficiently described issues will be closed, so please provide as much information as possible
+      options:
+        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
+        - label: Have you read our contribution guidelines?
+        - label: Is this feature aligned with the project's goals and scope?
+        - label: Have you considered the impact on existing features and users?
-  - type: checkboxes
-    id: search
-    attributes:
-      label: Search checkbox
-      description: Insufficiently described issues will be closed, so please provide as much information as possible
-      options:
-        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Search checkbox
+      description: Insufficiently described issues will be closed, so please provide as much information as possible
+      options:
+        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
+        - label: Have you read our contribution guidelines?
+        - label: Is this feature aligned with the project's goals and scope?
+        - label: Have you considered the impact on existing features and users?
+  - type: dropdown
+    id: platforms
+    attributes:
+      label: Platforms
+      multiple: true
+      options:
+        - all
+        - Website
+        - Docs
+        - Portal
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: A brief description of what the issue of the feature request is
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Solution
+      description: A brief description of the solution taken
+    validations:
+      required: true
-  - type: textarea
-    id: solution
-    attributes:
-      label: Solution
-      description: A brief description of the solution taken
-    validations:
-      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Solution
+      description: |
+        Describe your proposed solution in detail:
+        - How would this feature work?
+        - What are the expected inputs and outputs?
+        - How would users interact with this feature?
+        - What are the technical requirements?
+    validations:
+      required: true
-  - type: textarea
-    id: solution
-    attributes:
-      label: Solution
-      description: A brief description of the solution taken
-    validations:
-      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Solution
+      description: |
+        Describe your proposed solution in detail:
+        - How would this feature work?
+        - What are the expected inputs and outputs?
+        - How would users interact with this feature?
+        - What are the technical requirements?
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: A brief description of any alternatives considered
+    validations:
+      required: true
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional Context
+      description: Any additional context or information (screenshots can be placed here)
@@ -0,0 +1,31 @@
+name: Other
+description: Create an issue that doesn't fit into any other category
+title: 'type(scope-of-issue): description'
+body:
+  - type: checkboxes
+    id: search
+    attributes:
+      label: Search checkbox
+      description: Insufficiently described issues will be closed, so please provide as much information as possible
+      options:
+        - label: Have you searched for similar [issues](https://github.com/cuhacking/2025/issues)?
+  - type: dropdown
+    id: platforms
+    attributes:
+      label: Platforms
+      multiple: true
+      options:
+        - all
+        - Website
+        - Docs
+        - Portal
+      default: 0
+    validations:
+      required: true
-  - type: dropdown
-    id: platforms
-    attributes:
-      label: Platforms
-      multiple: true
-      options:
-        - all
-        - Website
-        - Docs
-        - Portal
-      default: 0
-    validations:
-      required: true
+  - type: dropdown
+    id: platforms
+    attributes:
+      label: Platforms
+      multiple: true
+      options:
+        - Website
+        - Docs
+        - Portal
+        - Infrastructure
+        - Database
+        - API
+        - Mobile App
+        - Other (specify in description)
+    validations:
+      required: true
-  - type: dropdown
-    id: platforms
-    attributes:
-      label: Platforms
-      multiple: true
-      options:
-        - all
-        - Website
-        - Docs
-        - Portal
-      default: 0
-    validations:
-      required: true
+  - type: dropdown
+    id: platforms
+    attributes:
+      label: Platforms
+      multiple: true
+      options:
+        - Website
+        - Docs
+        - Portal
+        - Infrastructure
+        - Database
+        - API
+        - Mobile App
+        - Other (specify in description)
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A brief description of what needs to be done
+    validations:
+      required: true
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: cuHacking Website
+    url: https://cuhacking.ca/
+    about: Please find all of our media links here to reach out to us.