From 02d30d6e9494d3f7fc091f8ab668acd411e8927a Mon Sep 17 00:00:00 2001 From: Rachael-Chan Date: Tue, 1 Oct 2024 16:00:51 +0800 Subject: [PATCH 01/10] docs: Update AboutUs with personal info --- docs/AboutUs.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 8cf4ab68e9e..6faf0b99093 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -50,12 +50,11 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` * Role: Developer * Responsibilities: Dev Ops + Threading -### James Doe +### Rachael Chan + - - -[[github](http://github.com/johndoe)] -[[portfolio](team/johndoe.md)] +[[github](http://github.com/rachael-chan)] +[[portfolio](team/rachaelchan.md)] -* Role: Developer -* Responsibilities: UI +* Role: Software Engineer +* Responsibilities: Data From 8a1e4f8bee8087e51dc423078b729259c9a635d6 Mon Sep 17 00:00:00 2001 From: Andrew22Teoh <122327616+Andrew22Teoh@users.noreply.github.com> Date: Tue, 1 Oct 2024 19:37:34 +0800 Subject: [PATCH 02/10] Update AboutUs.md --- docs/AboutUs.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 8cf4ab68e9e..c9cf49ad592 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -11,15 +11,15 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` ## Project team -### John Doe +### Andrew Teoh - + [[homepage](http://www.comp.nus.edu.sg/~damithch)] -[[github](https://github.com/johndoe)] +[[github](https://github.com/andrew22teoh)] [[portfolio](team/johndoe.md)] -* Role: Project Advisor +* Role: Project Team Member! ### Jane Doe From 65a1defaf315f5da4eac35fce18119a36b39a5a3 Mon Sep 17 00:00:00 2001 From: Andrew22Teoh <122327616+Andrew22Teoh@users.noreply.github.com> Date: Tue, 1 Oct 2024 19:43:56 +0800 Subject: [PATCH 03/10] Update AboutUs.md --- docs/AboutUs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index c9cf49ad592..010f041ff0b 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -15,11 +15,11 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` -[[homepage](http://www.comp.nus.edu.sg/~damithch)] [[github](https://github.com/andrew22teoh)] -[[portfolio](team/johndoe.md)] +[[portfolio](team/andrew22teoh.md)] -* Role: Project Team Member! +* Role: Project Team Member +* Responsibility: Reviewing and approving pull requests ### Jane Doe From 43c0ec46c289171a3d7179614d43198e7f8e68ea Mon Sep 17 00:00:00 2001 From: Andrew22Teoh <122327616+Andrew22Teoh@users.noreply.github.com> Date: Tue, 1 Oct 2024 20:30:45 +0800 Subject: [PATCH 04/10] Update AboutUs.md --- docs/AboutUs.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 010f041ff0b..af1f7140183 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -18,8 +18,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` [[github](https://github.com/andrew22teoh)] [[portfolio](team/andrew22teoh.md)] -* Role: Project Team Member -* Responsibility: Reviewing and approving pull requests +* Role: Team Lead ### Jane Doe From d28fb6d4b3af6a158c293a86d258a2a457bb0d8c Mon Sep 17 00:00:00 2001 From: Rachael-Chan Date: Tue, 1 Oct 2024 20:31:27 +0800 Subject: [PATCH 05/10] docs: Update responsibility --- docs/AboutUs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 6faf0b99093..6e6c138d32f 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -57,4 +57,4 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` [[portfolio](team/rachaelchan.md)] * Role: Software Engineer -* Responsibilities: Data +* Responsibilities: In charge of `Model` From 6a62c6de8b6ceba5ea3af13e246d70fa2790586a Mon Sep 17 00:00:00 2001 From: AbdulrahmanAlRammah <142239643+AbdulrahmanAlRammah@users.noreply.github.com> Date: Tue, 1 Oct 2024 20:31:54 +0800 Subject: [PATCH 06/10] Update About Us --- docs/AboutUs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 8cf4ab68e9e..04916ff4a16 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -50,11 +50,11 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` * Role: Developer * Responsibilities: Dev Ops + Threading -### James Doe +### Abdulrahman Al Rammah - + -[[github](http://github.com/johndoe)] +[[github](http://github.com/abdulrahmanalrammah)] [[portfolio](team/johndoe.md)] * Role: Developer From 2592be211bbd84020cbd842418e1a4db5fc5501e Mon Sep 17 00:00:00 2001 From: Andrew22Teoh Date: Tue, 1 Oct 2024 20:43:16 +0800 Subject: [PATCH 07/10] Create Andrew's markdown --- docs/team/andrew22teoh.md | 46 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/team/andrew22teoh.md diff --git a/docs/team/andrew22teoh.md b/docs/team/andrew22teoh.md new file mode 100644 index 00000000000..86aa7ebfc34 --- /dev/null +++ b/docs/team/andrew22teoh.md @@ -0,0 +1,46 @@ +--- + layout: default.md + title: "John Doe's Project Portfolio Page" +--- + +### Project: AddressBook Level 3 + +AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature**: Added the ability to undo/redo previous commands. + * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. + * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. + * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. + * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* + +* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. + +* **Code contributed**: [RepoSense link]() + +* **Project management**: + * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub + +* **Enhancements to existing features**: + * Updated the GUI color scheme (Pull requests [\#33](), [\#34]()) + * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]()) + +* **Documentation**: + * User Guide: + * Added documentation for the features `delete` and `find` [\#72]() + * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() + * Developer Guide: + * Added implementation details of the `delete` feature. + +* **Community**: + * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() + * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]()) + * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]()) + * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]()) + +* **Tools**: + * Integrated a third party library (Natty) to the project ([\#42]()) + * Integrated a new Github plugin (CircleCI) to the team repo + +* _{you can add/remove categories in the list above}_ From 1cf4508e07ffe41b304965907f99f261bf006a00 Mon Sep 17 00:00:00 2001 From: AbdulrahmanAlRammah <142239643+AbdulrahmanAlRammah@users.noreply.github.com> Date: Tue, 1 Oct 2024 20:43:16 +0800 Subject: [PATCH 08/10] Update Rammah Description --- docs/AboutUs.md | 4 +-- docs/team/abdulrahmanalrammah.md | 46 ++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 2 deletions(-) create mode 100644 docs/team/abdulrahmanalrammah.md diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 04916ff4a16..fdd0cf28dc2 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -55,7 +55,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` [[github](http://github.com/abdulrahmanalrammah)] -[[portfolio](team/johndoe.md)] +[[portfolio](team/abdulrahmanalrammah.md)] * Role: Developer -* Responsibilities: UI +* Responsibilities: Documentation diff --git a/docs/team/abdulrahmanalrammah.md b/docs/team/abdulrahmanalrammah.md new file mode 100644 index 00000000000..86aa7ebfc34 --- /dev/null +++ b/docs/team/abdulrahmanalrammah.md @@ -0,0 +1,46 @@ +--- + layout: default.md + title: "John Doe's Project Portfolio Page" +--- + +### Project: AddressBook Level 3 + +AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **New Feature**: Added the ability to undo/redo previous commands. + * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. + * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. + * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. + * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* + +* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. + +* **Code contributed**: [RepoSense link]() + +* **Project management**: + * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub + +* **Enhancements to existing features**: + * Updated the GUI color scheme (Pull requests [\#33](), [\#34]()) + * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]()) + +* **Documentation**: + * User Guide: + * Added documentation for the features `delete` and `find` [\#72]() + * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() + * Developer Guide: + * Added implementation details of the `delete` feature. + +* **Community**: + * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() + * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]()) + * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]()) + * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]()) + +* **Tools**: + * Integrated a third party library (Natty) to the project ([\#42]()) + * Integrated a new Github plugin (CircleCI) to the team repo + +* _{you can add/remove categories in the list above}_ From 85132233033b41b6e906054a4c185ceaf1b7b793 Mon Sep 17 00:00:00 2001 From: rayray39 Date: Tue, 1 Oct 2024 20:43:27 +0800 Subject: [PATCH 09/10] Update AboutUs.md --- docs/AboutUs.md | 6 +++--- docs/team/rayray39.md | 0 2 files changed, 3 insertions(+), 3 deletions(-) create mode 100644 docs/team/rayray39.md diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 8cf4ab68e9e..acffa3ac6a0 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -50,11 +50,11 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` * Role: Developer * Responsibilities: Dev Ops + Threading -### James Doe +### Rayner Lim Fang Yuh - + -[[github](http://github.com/johndoe)] +[[github](http://github.com/rayray39)] [[portfolio](team/johndoe.md)] * Role: Developer diff --git a/docs/team/rayray39.md b/docs/team/rayray39.md new file mode 100644 index 00000000000..e69de29bb2d From f0ebe0ccc86e22440cb194e476f0c1f244575998 Mon Sep 17 00:00:00 2001 From: Andrew22Teoh <122327616+Andrew22Teoh@users.noreply.github.com> Date: Tue, 1 Oct 2024 20:43:43 +0800 Subject: [PATCH 10/10] Update andrew22teoh.md --- docs/team/andrew22teoh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/team/andrew22teoh.md b/docs/team/andrew22teoh.md index 86aa7ebfc34..7341004aff1 100644 --- a/docs/team/andrew22teoh.md +++ b/docs/team/andrew22teoh.md @@ -1,6 +1,6 @@ --- layout: default.md - title: "John Doe's Project Portfolio Page" + title: "Andrew Teoh's Project Portfolio Page" --- ### Project: AddressBook Level 3