From 02bfe7f6b5bd738df096a1fc8378ba6f49ff83ac Mon Sep 17 00:00:00 2001 From: Ludwig Holl Date: Wed, 6 Nov 2024 13:12:06 +0100 Subject: [PATCH 1/7] updated issue templates --- .github/ISSUE_TEMPLATE/BUG.yml | 61 ++++++++++++++++++++--- .github/ISSUE_TEMPLATE/FEATURE.yml | 55 +++++++++++++++++---- .github/ISSUE_TEMPLATE/ISSUE.yml | 79 ++++++++++++------------------ 3 files changed, 132 insertions(+), 63 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml index ab864385..a6a4b49a 100644 --- a/.github/ISSUE_TEMPLATE/BUG.yml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -1,24 +1,73 @@ name: 🐞 Bug title: "[Bug]: " -description: Something doesn't behave as it should. +description: A bug that requires attention. labels: ["bug"] body: - type: textarea id: current attributes: label: Current Behavior - placeholder: The car doesnt see a traffic light on Map1. + description: Describe the current, unexpected behavior. + placeholder: The car doesn’t detect the traffic light on Map1. - type: textarea id: expected attributes: label: Expected Behavior - placeholder: The car does see the traffic light on Map1. + description: Describe the expected, correct behavior. + placeholder: The car should detect the traffic light on Map1. - type: textarea id: reproduce attributes: - label: How to reproduce the issue + label: Steps to Reproduce + description: Provide steps to reproduce the issue. placeholder: | - * Start the simulation with Map1 - * after 600m the car won't stop at the traffic light. \ No newline at end of file + * Start simulation on Map1. + * After 600m, the car should stop at the traffic light. + + - type: textarea + id: definition_of_done + attributes: + label: Definition of Done + description: Criteria to consider this issue resolved. + placeholder: | + - The car detects traffic lights on Map1 correctly. + - The issue no longer occurs in similar scenarios. + + - type: input + id: effort_estimate + attributes: + label: Effort Estimate + description: Approximate effort required (e.g., hours). + placeholder: Enter effort estimate. + + - type: textarea + id: testability + attributes: + label: Testability + description: Describe how to test the fix. + placeholder: Describe testing steps for verification. + + - type: textarea + id: dependencies + attributes: + label: Dependencies + description: List any dependent tasks or issues. + placeholder: Link dependencies here (e.g., #123). + + - type: markdown + attributes: + value: | + **Add Priority Label**: + - p1: Immediate attention + - p2: High priority + - p3: Standard priority + - p4: Low priority + + **Add Group Label**: + - perception: Related to sensor processing and scene understanding + - planning: Related to path planning and decision making + - acting: Related to vehicle control and actuation + - research: Related to research and experimentation + - infrastructure: Related to system infrastructure and setup diff --git a/.github/ISSUE_TEMPLATE/FEATURE.yml b/.github/ISSUE_TEMPLATE/FEATURE.yml index 65b5c9a6..80f6b3ac 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE.yml @@ -1,20 +1,57 @@ name: 💡 Feature title: "[Feature]: " -description: Something we should implement. +description: A new feature to be implemented. labels: ["feature"] body: - type: textarea - id: desc + id: description attributes: - label: Description - description: Short description about what to do. - placeholder: The vehicle should detect traffic lights and it's states. + label: Feature Description + description: Provide a summary of the feature. + placeholder: The vehicle should detect traffic lights and their states. - type: textarea - id: dod + id: definition_of_done attributes: label: Definition of Done - description: What is required to mark the issue as done? + description: Completion criteria for the feature. placeholder: | - - 90% of the traffic lights are detected - - 90% of the traffic light states are detected correctly" \ No newline at end of file + - Detects 90% of traffic lights. + - Correctly identifies 90% of traffic light states. + + - type: input + id: effort_estimate + attributes: + label: Effort Estimate + description: Estimated effort (e.g., in hours). + placeholder: Enter effort estimate. + + - type: textarea + id: testability + attributes: + label: Testability + description: How will the feature be tested? + placeholder: Describe test cases and success criteria. + + - type: textarea + id: dependencies + attributes: + label: Dependencies + description: List any dependencies on other issues. + placeholder: Link dependencies here (e.g., #456). + + - type: markdown + attributes: + value: | + **Add Priority Label**: + - p1: Immediate attention + - p2: High priority + - p3: Standard priority + - p4: Low priority + + **Add Group Label**: + - perception: Related to sensor processing and scene understanding + - planning: Related to path planning and decision making + - acting: Related to vehicle control and actuation + - research: Related to research and experimentation + - infrastructure: Related to system infrastructure and setup diff --git a/.github/ISSUE_TEMPLATE/ISSUE.yml b/.github/ISSUE_TEMPLATE/ISSUE.yml index 0ebbfe5d..45ec9c37 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE.yml +++ b/.github/ISSUE_TEMPLATE/ISSUE.yml @@ -1,78 +1,55 @@ -name: "Issue Template" -description: "Template for creating issues" -labels: [] -assignees: [] +name: "General Issue" +title: "[General]: " +description: Template for general issues. +labels: ["general"] body: - - type: markdown - attributes: - value: | - ## Please fill out all relevant fields: - - type: textarea id: description attributes: - label: "Detailed Description" - description: "Describe the issue in detail" + label: Detailed Description + description: Describe the issue in detail. placeholder: | - Enter description here + Enter description here: - What is the problem? - - What is the expected behavior? - - What is the actual behavior? + - What is the expected outcome? - type: textarea id: definition_of_done attributes: - label: "Definition of Done" - description: "What needs to be completed for the task to be considered done?" + label: Definition of Done + description: Criteria for considering the task complete. placeholder: | - Example criteria: - - [ ] Implementation completed and tested - - [ ] Documentation updated - - [ ] Code review passed - - [ ] All tests passing + - Implementation completed and tested + - Documentation updated + - Code review passed + - All tests passing - type: input id: effort_estimate attributes: - label: "Effort Estimate" - description: "Estimate the effort required (e.g., in hours)" - placeholder: "Enter effort estimate here" + label: Effort Estimate + description: Estimate the effort required. + placeholder: Enter effort estimate here. - type: textarea id: testability attributes: - label: "Testability" - description: "How can the implementation be tested?" - placeholder: "Enter testing methods here" + label: Testability + description: How to verify the issue's resolution. + placeholder: Enter test methods and validation criteria. - type: textarea id: dependencies attributes: - label: "Dependencies" - description: "Are there dependencies on other tasks or systems?" - placeholder: | - Enter dependencies here - - Task A must be completed before this task can start - - Link issues here with # + label: Dependencies + description: List dependencies, if any. + placeholder: Link dependencies here (e.g., #789). - type: markdown - id: prioritization attributes: value: | - Add a priority label to this issue (p1 to p4) based on the following criteria: - - p1: Critical issue that needs immediate attention - - p2: Important issue that should be addressed soon - - p3: Issue that should be addressed in the near future - - p4: Issue that can be addressed later - - - type: markdown - id: labels - attributes: - value: | - Add any relevant labels to this issue: - - standard labels: + **Add Standard Label**: - bug: Something isn't working - enhancement: New feature or request - help wanted: Extra attention is needed @@ -81,7 +58,13 @@ body: - question: Further information is requested - wontfix: This will not be worked on - project-specific labels: + **Add Priority Label**: + - p1: Immediate attention + - p2: High priority + - p3: Standard priority + - p4: Low priority + + **Add Group Label**: - perception: Related to sensor processing and scene understanding - planning: Related to path planning and decision making - acting: Related to vehicle control and actuation From 9f66f64c5ff48e90559c98c5f9ed551a4819bd72 Mon Sep 17 00:00:00 2001 From: Ludwig <66259585+SirMDA@users.noreply.github.com> Date: Sun, 10 Nov 2024 13:27:25 +0100 Subject: [PATCH 2/7] Update .github/ISSUE_TEMPLATE/BUG.yml Co-authored-by: asamluka --- .github/ISSUE_TEMPLATE/BUG.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml index a6a4b49a..2b5787e0 100644 --- a/.github/ISSUE_TEMPLATE/BUG.yml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -69,5 +69,6 @@ body: - perception: Related to sensor processing and scene understanding - planning: Related to path planning and decision making - acting: Related to vehicle control and actuation + - system: Related to the general behavior of the system - research: Related to research and experimentation - infrastructure: Related to system infrastructure and setup From d69d71aa25b3ebdf0d3248fa334bec04349993be Mon Sep 17 00:00:00 2001 From: Ludwig <66259585+SirMDA@users.noreply.github.com> Date: Sun, 10 Nov 2024 13:27:33 +0100 Subject: [PATCH 3/7] Update .github/ISSUE_TEMPLATE/FEATURE.yml Co-authored-by: asamluka --- .github/ISSUE_TEMPLATE/FEATURE.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/FEATURE.yml b/.github/ISSUE_TEMPLATE/FEATURE.yml index 80f6b3ac..2076d028 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE.yml @@ -53,5 +53,6 @@ body: - perception: Related to sensor processing and scene understanding - planning: Related to path planning and decision making - acting: Related to vehicle control and actuation + - system: Related to the general behavior of the system - research: Related to research and experimentation - infrastructure: Related to system infrastructure and setup From 483fb6bc815772b98d9ba39fe205a7b52fcd0901 Mon Sep 17 00:00:00 2001 From: Ludwig <66259585+SirMDA@users.noreply.github.com> Date: Sun, 10 Nov 2024 13:27:42 +0100 Subject: [PATCH 4/7] Update .github/ISSUE_TEMPLATE/ISSUE.yml Co-authored-by: asamluka --- .github/ISSUE_TEMPLATE/ISSUE.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/ISSUE.yml b/.github/ISSUE_TEMPLATE/ISSUE.yml index 45ec9c37..e41a074c 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE.yml +++ b/.github/ISSUE_TEMPLATE/ISSUE.yml @@ -68,5 +68,6 @@ body: - perception: Related to sensor processing and scene understanding - planning: Related to path planning and decision making - acting: Related to vehicle control and actuation + - system: Related to the general behavior of the system - research: Related to research and experimentation - infrastructure: Related to system infrastructure and setup From 71a3cdd22b2c64b84002f6f88d8c087ca5f46d61 Mon Sep 17 00:00:00 2001 From: Ludwig <66259585+SirMDA@users.noreply.github.com> Date: Sun, 10 Nov 2024 13:28:06 +0100 Subject: [PATCH 5/7] Update .github/ISSUE_TEMPLATE/ISSUE.yml Co-authored-by: asamluka --- .github/ISSUE_TEMPLATE/ISSUE.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/ISSUE.yml b/.github/ISSUE_TEMPLATE/ISSUE.yml index e41a074c..9b8c80ca 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE.yml +++ b/.github/ISSUE_TEMPLATE/ISSUE.yml @@ -29,8 +29,8 @@ body: id: effort_estimate attributes: label: Effort Estimate - description: Estimate the effort required. - placeholder: Enter effort estimate here. + description: Approximate effort required (e.g., hours). + placeholder: Enter effort estimate. - type: textarea id: testability From 060bb9f93995dd3585fc09cc4761c7ecec8df198 Mon Sep 17 00:00:00 2001 From: Ludwig <66259585+SirMDA@users.noreply.github.com> Date: Sun, 10 Nov 2024 13:28:18 +0100 Subject: [PATCH 6/7] Update .github/ISSUE_TEMPLATE/FEATURE.yml Co-authored-by: asamluka --- .github/ISSUE_TEMPLATE/FEATURE.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/FEATURE.yml b/.github/ISSUE_TEMPLATE/FEATURE.yml index 2076d028..82d8c642 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE.yml @@ -23,7 +23,7 @@ body: id: effort_estimate attributes: label: Effort Estimate - description: Estimated effort (e.g., in hours). + description: Approximate effort required (e.g., hours). placeholder: Enter effort estimate. - type: textarea From 14c098b4b4b84af351f714bfe87510905a534e52 Mon Sep 17 00:00:00 2001 From: Ludwig <66259585+SirMDA@users.noreply.github.com> Date: Sun, 10 Nov 2024 13:28:35 +0100 Subject: [PATCH 7/7] Update .github/ISSUE_TEMPLATE/ISSUE.yml Co-authored-by: asamluka --- .github/ISSUE_TEMPLATE/ISSUE.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/ISSUE.yml b/.github/ISSUE_TEMPLATE/ISSUE.yml index 9b8c80ca..25bc8724 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE.yml +++ b/.github/ISSUE_TEMPLATE/ISSUE.yml @@ -44,7 +44,7 @@ body: attributes: label: Dependencies description: List dependencies, if any. - placeholder: Link dependencies here (e.g., #789). + placeholder: Link dependencies here (e.g., the issue #789). - type: markdown attributes: