From 90cf9f31322e3da23e85ccff9160059574ae4727 Mon Sep 17 00:00:00 2001 From: Ludwig Holl Date: Sat, 23 Nov 2024 16:10:40 +0100 Subject: [PATCH 1/3] updated project management.md and issue templates --- .github/ISSUE_TEMPLATE/BUG.yml | 13 ------------- .github/ISSUE_TEMPLATE/FEATURE.yml | 12 ------------ .github/ISSUE_TEMPLATE/ISSUE.yml | 13 ------------- doc/development/project_management.md | 21 +++++++++++++++++++++ 4 files changed, 21 insertions(+), 38 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml index aee5410c..afed0980 100644 --- a/.github/ISSUE_TEMPLATE/BUG.yml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -35,13 +35,6 @@ body: - 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: @@ -59,12 +52,6 @@ body: - 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 diff --git a/.github/ISSUE_TEMPLATE/FEATURE.yml b/.github/ISSUE_TEMPLATE/FEATURE.yml index 366bab21..3c906a58 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE.yml @@ -19,13 +19,6 @@ body: - 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: @@ -43,11 +36,6 @@ body: - 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 diff --git a/.github/ISSUE_TEMPLATE/ISSUE.yml b/.github/ISSUE_TEMPLATE/ISSUE.yml index 6ad88fbf..355cb64f 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE.yml +++ b/.github/ISSUE_TEMPLATE/ISSUE.yml @@ -25,13 +25,6 @@ body: - Code review passed - All tests passing - - 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: @@ -58,12 +51,6 @@ body: - question: Further information is requested - wontfix: This will not be worked on - **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 diff --git a/doc/development/project_management.md b/doc/development/project_management.md index 29a1a0f0..cb4d590e 100644 --- a/doc/development/project_management.md +++ b/doc/development/project_management.md @@ -13,6 +13,27 @@ Issues can be added via the [issues overview](https://github.com/una-auxme/paf/i By clicking "New issue" in the overview you have different templates to create the issue. +After creating the issue it has to be added to the project board. The project board is used to keep track of the +progress of the issue. The project board can be found [here](https://github.com/orgs/una-auxme/projects/3). + +For tracking time and complexity of the issue we will use the predefined `Priority` and `Size` states of the PAF Project +Backlog Board. + +Priority has following states: +- `Urgent`: Critical bug causing system crash, needs immediate fix. +- `High`: Major feature request or significant bug affecting many users. +- `Medium`: Minor feature request or bug with a workaround. +- `Low`: Cosmetic changes or minor improvements. + +Size has following states: +- `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes. +- `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours. +- `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days. +- `Large`: Major feature implementation or significant refactor. Estimated time: 1-2 weeks. +- `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should + be tagged with this size. + + ## 2. Create a Pull Request To create a pull request, go to the [branches overview](https://github.com/una-auxme/paf/branches) and select ``New Pull Request`` for the branch you want to create a PR for. From 9c40f314a3aeb82a7cf825f631158fab48d2ad05 Mon Sep 17 00:00:00 2001 From: Ludwig Holl Date: Sat, 23 Nov 2024 16:12:58 +0100 Subject: [PATCH 2/3] added size and prio information to the issue templates --- .github/ISSUE_TEMPLATE/BUG.yml | 15 +++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE.yml | 15 +++++++++++++++ .github/ISSUE_TEMPLATE/ISSUE.yml | 15 +++++++++++++++ 3 files changed, 45 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/BUG.yml b/.github/ISSUE_TEMPLATE/BUG.yml index afed0980..0bdbe38e 100644 --- a/.github/ISSUE_TEMPLATE/BUG.yml +++ b/.github/ISSUE_TEMPLATE/BUG.yml @@ -59,3 +59,18 @@ body: - system: Related to the general behavior of the system - research: Related to research and experimentation - infrastructure: Related to system infrastructure and setup + + **Add Labels on the Project Board**: + **Priority:** + - `Urgent`: Critical bug causing system crash, needs immediate fix. + - `High`: Major feature request or significant bug affecting many users. + - `Medium`: Minor feature request or bug with a workaround. + - `Low`: Cosmetic changes or minor improvements. + + **Size:** + - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes. + - `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours. + - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days. + - `Large`: Major feature implementation or significant refactor. Estimated time: 1-2 weeks. + - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should + be tagged with this size. diff --git a/.github/ISSUE_TEMPLATE/FEATURE.yml b/.github/ISSUE_TEMPLATE/FEATURE.yml index 3c906a58..bdb42505 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE.yml @@ -44,3 +44,18 @@ body: - system: Related to the general behavior of the system - research: Related to research and experimentation - infrastructure: Related to system infrastructure and setup + + **Add Labels on the Project Board**: + **Priority:** + - `Urgent`: Critical bug causing system crash, needs immediate fix. + - `High`: Major feature request or significant bug affecting many users. + - `Medium`: Minor feature request or bug with a workaround. + - `Low`: Cosmetic changes or minor improvements. + + **Size:** + - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes. + - `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours. + - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days. + - `Large`: Major feature implementation or significant refactor. Estimated time: 1-2 weeks. + - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should + be tagged with this size. diff --git a/.github/ISSUE_TEMPLATE/ISSUE.yml b/.github/ISSUE_TEMPLATE/ISSUE.yml index 355cb64f..e5cbc82c 100644 --- a/.github/ISSUE_TEMPLATE/ISSUE.yml +++ b/.github/ISSUE_TEMPLATE/ISSUE.yml @@ -58,3 +58,18 @@ body: - system: Related to the general behavior of the system - research: Related to research and experimentation - infrastructure: Related to system infrastructure and setup + + **Add Labels on the Project Board**: + **Priority:** + - `Urgent`: Critical bug causing system crash, needs immediate fix. + - `High`: Major feature request or significant bug affecting many users. + - `Medium`: Minor feature request or bug with a workaround. + - `Low`: Cosmetic changes or minor improvements. + + **Size:** + - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes. + - `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours. + - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days. + - `Large`: Major feature implementation or significant refactor. Estimated time: 1-2 weeks. + - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should + be tagged with this size. From bf594eee06f564485a0233ed2a6a7c178f5027e9 Mon Sep 17 00:00:00 2001 From: Ludwig Holl Date: Sat, 23 Nov 2024 16:18:58 +0100 Subject: [PATCH 3/3] fixed md linter --- doc/development/project_management.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/development/project_management.md b/doc/development/project_management.md index cb4d590e..ef5e45d7 100644 --- a/doc/development/project_management.md +++ b/doc/development/project_management.md @@ -13,19 +13,21 @@ Issues can be added via the [issues overview](https://github.com/una-auxme/paf/i By clicking "New issue" in the overview you have different templates to create the issue. -After creating the issue it has to be added to the project board. The project board is used to keep track of the +After creating the issue it has to be added to the project board. The project board is used to keep track of the progress of the issue. The project board can be found [here](https://github.com/orgs/una-auxme/projects/3). For tracking time and complexity of the issue we will use the predefined `Priority` and `Size` states of the PAF Project Backlog Board. Priority has following states: + - `Urgent`: Critical bug causing system crash, needs immediate fix. - `High`: Major feature request or significant bug affecting many users. - `Medium`: Minor feature request or bug with a workaround. - `Low`: Cosmetic changes or minor improvements. Size has following states: + - `Tiny`: Small typo fix or minor code refactor. Estimated time: 30 minutes. - `Small`: Simple bug fix or small feature addition. Estimated time: 1-2 hours. - `Medium`: Moderate feature addition or multiple bug fixes. Estimated time: 1-2 days. @@ -33,7 +35,6 @@ Size has following states: - `X-Large`: Large-scale feature or complete module overhaul. Estimated time: 2-4 weeks. Especially `EPIC` issues should be tagged with this size. - ## 2. Create a Pull Request To create a pull request, go to the [branches overview](https://github.com/una-auxme/paf/branches) and select ``New Pull Request`` for the branch you want to create a PR for.