Merge pull request #19 from MSU-AI/dev

Dev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,57 @@
+name: Bug Report
+description: Create a bug report to help improve CR-RL
+labels: [bug]
+body:
+
+  # Description
+  - type: textarea
+    attributes:
+      label: Description
+      description: A clear and concise description of what the issue is.
+    validations:
+      required: true
+
+  # Step To Reproduce
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1.
+        2.
+        3.
+    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
+
+  # Python Version
+  - type: input
+    id: python_version
+    attributes:
+      label: Python Version
+      description: Which version of Python are you using?
+      placeholder: "e.g. 3.11"
+    validations:
+      required: true
+
+  # Log File
+  - type: textarea
+    attributes:
+      label: Log File
+      description: |
+        Please upload the log file as an attachment (DO NOT COPY OR PASTE THE CONTENTS INTO THIS FIELD)
+      placeholder: |
+        To upload the log, access it from Settings -> About -> Open log location; Or
+        - Select the `debug.log` file from `%localappdata%\Packages\49306atecsolution.FilesUWP_et10x9a9vyk8t\LocalState`
+        - Drag and drop the file to upload as an attachment 
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/code_quality_issue.yml

@@ -0,0 +1,38 @@
+name: Code Quality Issue
+description: Create a code quality issue to help CR-RL keep a clean codebase
+labels: [codebase quality]
+body:
+  - type: textarea
+    attributes:
+      label: Description
+      description: A clear and concise description of what the code quality issue is.
+    validations:
+      required: true
+  - 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
+  - type: textarea
+    attributes:
+      label: Gains
+      description: What would fixing this code quality issue bring to the source code? 
+      value: |
+        - eg. A better readability.
+        - eg. Uncoupling concepts X and Y.
+        - eg. Clarifying the responsibility of class C.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Requirements
+      description: Describe all the requirements to solve the code quality issue.
+      value: |
+        - eg. Using a specific design pattern.
+        - eg. Separating class I into three new classes I1, I2 and I3.
+        - eg. Regrouping the duplicated process into a new helper.
+  - type: textarea
+    attributes:
+      label: Comments
+      description: Additional information, comments or screenshots about the code quality issue.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,48 @@
+name: Feature Request
+description: This project thrives from differentiation from competing apps. Suggest an idea for CR-RL.
+labels: [feature request]
+body:
+
+  # Description
+  - type: textarea
+    attributes:
+      label: What feature or improvement do you think would benefit CR-RL?
+      description: Please include your use case
+    validations:
+      required: true
+
+  # Tooltip about Requirements
+  - type: markdown
+    attributes:
+      value: |
+        ---
+
+        Please include a list changes required to make this improvement. A good rule of thumb is to start your proposal with no more than 7 high-level requirements.
+
+  # Requirements
+  - type: textarea
+    attributes:
+      label: Requirements
+      description: Describe all the requirements to make your idea happen
+      value: |
+        - This proposal will accomplish X
+        - This proposal will accomplish Y
+        - This proposal will accomplish Z
+    validations:
+      required: true
+
+  # Python Version
+  - type: input
+    id: python_version
+    attributes:
+      label: Python Version
+      description: Which version of Python are you using?
+      placeholder: "e.g. 3.11"
+    validations:
+      required: true
+
+  # Additional Comments
+  - type: textarea
+    attributes:
+      label: Comments
+      description: Additional information, comments or screenshots about the feature request.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+```md
+<!-- 
+🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨🚨
+I ACKNOWLEDGE THE FOLLOWING BEFORE PROCEEDING:
+1. PR may be deleted if it is not following the template
+2. Add a clear title starting with "Feature:" or "Fix:"
+3. List any classes/functions used that are not yet defined.
+-->
+
+**Resolved / Related Issues**
+- [ ] Were these changes approved in an issue or discussion with the project maintainers? In order to prevent extra work, feature requests and changes to the codebase must be approved before the pull request will be reviewed. This prevents extra work for the contributors and maintainers.
+   Closes #issue...
+
+**Validation**
+How did you test these changes?
+- [ ] Did you run the python notebook and test your changes?
+- [ ] Did you implement any design changes to an existing feature?
+   - [ ] Was this change approved?
+- [ ] Are there any dependencies that have yet to be constructed?
+  Relies on ...
+- [ ] Are there any other steps that were used to validate these changes?
+  1. Unit/Function 
+  2. Discuss with AI side
+
+**Screenshots (optional)**
+Add screenshots here.
+
+```