Merge pull request #477 from oss-slu/improve-templates

Improve templates

Author: leandrumartin

.github/ISSUE_TEMPLATE/new-feature-request.md

@@ -5,22 +5,29 @@ labels: enhancement
 type: Feature
 ---
 
-## You would like to implement a new component? If yes, please provide all the necessary details
+## Feature Description
 
-A clear configuration of the component and its working principle. Ex. It uses PWM
+*A clear and concise description of the feature, and why it should be added to the project.*
 
-- GPIO pins that are used by this component.
-- Circuit diagram if available
-- Any additional chips are used. Ex: It uses ADC0834
+*If you would like to see a new component implemented, please provide as many details as possible, such as communication protocols used, GPIO pins used, circuit diagrams if available, and any additional chips necessary.*
 
-## Is your feature request related to a problem? Please describe.
+## ✅ Tasks to be Completed
 
-A clear and concise description of what the problem is. Ex: I have a problem with LED [...]
+*A checklist of individual tasks that likely must be done before the feature can be considered "complete".*
 
-## Describe the solution you'd like
+- [ ] Task 1:
+- [ ] Task 2:
+- [ ] Task 3:
 
-A clear and concise description of what you want to happen.
+## Acceptance Criteria
+
+*A checklist of conditions that must be met for this task to be considered complete. How will we verify that it's done correctly?*
+
+- [ ] The new feature is implemented as described.
+- [ ] All related code passes the repository's workflow checks (linting, tests).
+- [ ] The application runs without errors after the changes are made.
+- [ ] (If applicable) New automated tests have been added to cover the changes.
 
 ## Additional context
 
-Add any other context or screenshots about the feature request here.
+A*dd any other context or screenshots about the feature request here.*

.github/ISSUE_TEMPLATE/report-a-bug.md

@@ -7,30 +7,33 @@ type: Bug
 
 ## Describe the bug
 
-A clear and concise description of what the bug is.
+*A clear and concise description of what the bug is.*
 
 ## What component are you facing this issue with?
 
-The component details and what functionality causes this issue
+*The component details and what functionality causes this issue.*
 
 ## To Reproduce
 
-Steps to reproduce the behavior: For example
-
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. Run the component '....'
-5. See error
+*Steps to reproduce the behavior.*
 
 ## Expected behavior
 
-A clear and concise description of what you expected to happen.
+*A clear and concise description of what you expected to happen.*
 
 ## Screenshots
 
-If applicable, add screenshots to help explain your problem.
+*If applicable, add screenshots to help explain your problem.*
+
+## Acceptance Criteria
+
+*A checklist of conditions that must be met for this task to be considered complete. How will we verify that it's done correctly?*
+
+- [ ] The buggy behavior no longer occurs.
+- [ ] All related code passes the repository's workflow checks (linting, tests).
+- [ ] The application runs without new errors after the changes are made.
+- [ ] (If applicable) New automated tests have been added to cover the changes.
 
 ## Additional context
 
-Add any other context about the problem here.
+*Add any other context about the problem here.*

.github/ISSUE_TEMPLATE/task-card.md

@@ -0,0 +1,31 @@
+---
+name: General Task Card
+about: For standard development tasks, chores, or refactoring.
+labels: enhancement
+type: Task
+---
+
+## 🎯 Goal / Objective
+
+*A clear and concise description of what this task aims to achieve. Why is this task important?*
+
+## ✅ Tasks to be Completed
+
+*A checklist of the specific, actionable steps required to complete this issue. This helps track progress.*
+
+- [ ] Task 1:
+- [ ] Task 2:
+- [ ] Task 3:
+
+## Acceptance Criteria
+
+*A checklist of conditions that must be met for this task to be considered complete. How will we verify that it's done correctly?*
+
+- [ ] The new feature is implemented as described.
+- [ ] All related code passes the repository's workflow checks (linting, tests).
+- [ ] The application runs without errors after the changes are made.
+- [ ] (If applicable) New automated tests have been added to cover the changes.
+
+## Additional Context
+
+*Add any other context, notes, screenshots, or links that might be helpful for completing this task.*

.github/pull_request_template.md

@@ -1,8 +1,8 @@
 ## Pull Request Summary
 
-Closes #xxx
+Closes #xxx <!-- Add the issue number here -->
 
-<!-- Enter a brief description/summary of your PR here. What does it add, and why is it necessary? Does this new feature solve any problems or bugs? How was it tested — automated or manual software tests, physical hardware tests, or some other method or combination of testing techniques? -->
+*A brief description/summary of your PR. What does it add, and why is it necessary? Does this new feature solve any problems or bugs? How was it tested — automated or manual software tests, physical hardware tests, or some other method or combination of testing techniques?*
 
 ## PR Checklist
 
@@ -11,4 +11,4 @@ Closes #xxx
 
 ## Detailed Description
 
-<!-- Provide a more detailed description and any additional information. -->
+*A more detailed description and any additional information.*