diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml index ab864385..aee5410c 100644 --- a/.github/ISSUE_TEMPLATE/BUG.yml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -1,24 +1,74 @@ 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 + - system: Related to the general behavior of the system + - 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..366bab21 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE.yml @@ -1,20 +1,58 @@ 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: Approximate effort required (e.g., 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 + - system: Related to the general behavior of the system + - 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..6ad88fbf 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: Approximate effort required (e.g., hours). + placeholder: Enter effort estimate. - 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., the issue \#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,9 +58,16 @@ 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 + - system: Related to the general behavior of the system - research: Related to research and experimentation - infrastructure: Related to system infrastructure and setup diff --git a/doc/assets/research_assets/drawio_legend/Loesungs_Vorschlag.jpg b/doc/assets/research_assets/drawio_legend/Loesungs_Vorschlag.jpg new file mode 100644 index 00000000..2146e7dc Binary files /dev/null and b/doc/assets/research_assets/drawio_legend/Loesungs_Vorschlag.jpg differ diff --git a/doc/assets/research_assets/drawio_legend/Problem.jpg b/doc/assets/research_assets/drawio_legend/Problem.jpg new file mode 100644 index 00000000..d05f15cb Binary files /dev/null and b/doc/assets/research_assets/drawio_legend/Problem.jpg differ diff --git a/doc/assets/research_assets/drawio_legend/Team.jpg b/doc/assets/research_assets/drawio_legend/Team.jpg new file mode 100644 index 00000000..92743423 Binary files /dev/null and b/doc/assets/research_assets/drawio_legend/Team.jpg differ diff --git a/doc/assets/research_assets/drawio_legend/Ziel.jpg b/doc/assets/research_assets/drawio_legend/Ziel.jpg new file mode 100644 index 00000000..48b73172 Binary files /dev/null and b/doc/assets/research_assets/drawio_legend/Ziel.jpg differ diff --git a/doc/assets/research_assets/drawio_legend/gemeinsames_Problem.jpg b/doc/assets/research_assets/drawio_legend/gemeinsames_Problem.jpg new file mode 100644 index 00000000..01ec28e0 Binary files /dev/null and b/doc/assets/research_assets/drawio_legend/gemeinsames_Problem.jpg differ diff --git a/doc/assets/research_assets/drawio_legend/generell.jpg b/doc/assets/research_assets/drawio_legend/generell.jpg new file mode 100644 index 00000000..9dd47446 Binary files /dev/null and b/doc/assets/research_assets/drawio_legend/generell.jpg differ diff --git a/doc/assets/research_assets/drawio_legend/two_teams_problem.jpg b/doc/assets/research_assets/drawio_legend/two_teams_problem.jpg new file mode 100644 index 00000000..79b917c0 Binary files /dev/null and b/doc/assets/research_assets/drawio_legend/two_teams_problem.jpg differ diff --git "a/doc/assets/research_assets/drawio_legend/\303\234bergeordnetes_Problem.jpg" "b/doc/assets/research_assets/drawio_legend/\303\234bergeordnetes_Problem.jpg" new file mode 100644 index 00000000..88862627 Binary files /dev/null and "b/doc/assets/research_assets/drawio_legend/\303\234bergeordnetes_Problem.jpg" differ diff --git a/doc/general/drawio_board.md b/doc/general/drawio_board.md new file mode 100644 index 00000000..1b866821 --- /dev/null +++ b/doc/general/drawio_board.md @@ -0,0 +1,53 @@ +# Drawio Board for planning future work + +**Summary:** This page provides an overview of the draw.io board usage and provides links to videos with general tips on how to work with draw.io + +- [Drawio Board for planning future work](#drawio-board-for-planning-future-work) + - [Link](#link) + - [Legend](#legend) + - [Tips](#tips) + +## Link + +To access the draw.io board, please click [here](https://drive.google.com/drive/folders/1dNyrnDdsj0m7kymDQUUqu2WinR4lQJpe) + +## Legend + +Please use the predefined nodes when working with the board. If you think something is missing, please contact Marcin Kuhnert (Discord: RoyaLxPole) for the PAF24. +Explanation: + +![Ziele](../assets/research_assets/drawio_legend/Ziel.jpg) + +This node is primarily for the software engineers who define the goals or sub-goals to be achieved for all teams. The goals should be defined as precisely as possible.These goals are added either in a separate graph or directly above the problems. + +![Team](../assets/research_assets/drawio_legend/Team.jpg) + +This node is for assigning the respective teams or a person from a team. Each team is assigned its own color. Green for Perception, Red for Acting, and Blue for Planning. + +![Uebergeordnetes Problem](../assets/research_assets/drawio_legend/Übergeordnetes_Problem.jpg) + +This node is used to describe a higher-level problem that cannot currently be defined in detail or can be broken down into smaller problems. As described in the previous node, each team has its own color. +If there is a problem that affects two teams, the color is determined by adding the colors in hexadecimal notation. + +![two teams prolbem](../assets/research_assets/drawio_legend/two_teams_problem.jpg) + +Example for problem that affects two teams (HEX: 00FFFF): + +![Problem](../assets/research_assets/drawio_legend/Problem.jpg)![gemeinsam](../assets/research_assets/drawio_legend/gemeinsames_Problem.jpg) + +This node is used to provide a description for an atomic problem that cannot be further simplified. The color coding for this node applies as described above. + +![Loesungs Vorschlag](../assets/research_assets/drawio_legend/Loesungs_Vorschlag.jpg) + +This node is used to describe the approach to the problem. If an issue has already been created on GitHub, the issue number should be included here. + +![generell](../assets/research_assets/drawio_legend/generell.jpg) +These nodes are used to describe problems that have not yet been assigned to a team or to describe problems that affect all teams equally. + +## Tips + +For effective work on the board, please watch the following video and read the blog posting. + +[Video](https://www.google.com/search?q=draw.io+mind+map+tutorial&rlz=1C1VDKB_deDE929DE929&oq=draw+io+mind&gs_lcrp=EgZjaHJvbWUqCAgDEAAYFhgeMggIABBFGCcYOzIGCAEQRRg5MgcIAhAAGIAEMggIAxAAGBYYHjIICAQQABgWGB4yCAgFEAAYFhgeMgYIBhBFGDwyBggHEEUYPdIBCDgyNzBqMGo3qAIAsAIA&sourceid=chrome&ie=UTF-8#fpstate=ive&vld=cid:6448d106,vid:mooBFL_jhxg,st:0) + +[Blog](https://drawio-app.com/blog/organization-charts-and-mind-maps-in-draw-io/)