From da53bd294e0a028ac834e139c12ac00499d729b7 Mon Sep 17 00:00:00 2001 From: LovleenKala <132896276+LovleenKala@users.noreply.github.com> Date: Fri, 16 May 2025 23:13:28 +1000 Subject: [PATCH] Component Review for group-set-editor --- .../Project-Templates/Component-Review.md | 52 ++++++++++++------- 1 file changed, 34 insertions(+), 18 deletions(-) diff --git a/docs/Templates/Project-Templates/Component-Review.md b/docs/Templates/Project-Templates/Component-Review.md index 2ec693adb..b2aa1d5cc 100644 --- a/docs/Templates/Project-Templates/Component-Review.md +++ b/docs/Templates/Project-Templates/Component-Review.md @@ -1,36 +1,52 @@ -# Ontrack Component review +Screenshot 2025-05-16 at 6 19 06 PM# Ontrack Component review ## Team Member Name - -First select a component to review from the list below: - +Lovleen Kala ## Component Name -Here you should enter the component name, also list all the files in this component. +Group-Set-Editor + +Files Included: +group-set-editor.component.ts +group-set-editor.component.html +group-set-editor.component.scss + ## Component purpose -What is the primary purpose of this component and how doesit work? Screenshots are advised. +The Group Set Editor component is a parent component that contains nested components, including the group-member-list and group-selector. These nested components handle more specific tasks, such as managing individual group members and selecting groups within a group set, while the Group Set Editor serves as the overall manager for group set interactions within a unit context. + +![Copy of Blank diagram-2](https://github.com/user-attachments/assets/6bedc863-3a6d-4e3c-82c6-f3f2179afa62) + + +The primary purpose of the Group Set Editor component is to manage group sets within a unit context. It allows tutors and convenors to add, remove, lock, and update groups within a selected group set. It also supports features like group filtering, sorting, and pagination, and integrates with services like newGroupService, alertService, and groupService. + +Before Migration: + +Screenshot 2025-05-16 at 6 19 06 PM + +Screenshot 2025-05-16 at 6 19 16 PM + ## Component outcomes and interactions -What are the expected outcomes of the component and what does it interact with, what kind of data -objects is it taking in and passing out? +Expected outcomes: -## Component migration plan +Allows users to create, edit, lock, and delete groups within a group set context. + +Provides real-time feedback for group updates using alertService. -First add your plan for the migration, how will you do this, what steps are needed. Add some -sketches or diagrams, what will the migrated component look like compared to the current one. +Supports filtering and sorting of group lists based on group names and tutorial assignments. + +Interacts with Group, Unit, Project, GroupSet, and UnitRole models for data handling. + +## Component migration plan -## Component review checklist +Migrate the TypeScript file to Angular 17, preserving the original logic for group management. -Next add a checklist similar to: then create a checklist: +I plan to manually include the code for group-member-list and group-selector directly within the group-set-editor component rather than pulling from two separate branches. This approach aims to minimize the risk of merge conflicts that could arise from integrating separate branches. -[ ] ability to collect details from the user [ ] succeeds when data is valid [ ] handles errors - -duplicate unit code in the teaching period, or invalid dates [ ] created unit is shown on success +Test the component against common scenarios, including group creation, deletion, and data export. -## Discussion with Client (Andrew Cain) -Finally you will need to take the feedback from Andrew and Discuss any addtional considertions he -may have with this component before writing any code.