From ad0e87816f6c0c73136b0dcf3f1cab2a635b2e37 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Sat, 11 Nov 2023 19:28:51 +0800 Subject: [PATCH 1/2] add ravern ppp --- docs/team/ravern.md | 43 ++++++++++++++++++------------------------- 1 file changed, 18 insertions(+), 25 deletions(-) diff --git a/docs/team/ravern.md b/docs/team/ravern.md index 869d68e7181..eb85731dd21 100644 --- a/docs/team/ravern.md +++ b/docs/team/ravern.md @@ -2,44 +2,37 @@ title: Ravern's Project Portfolio Page --- -### Project: TAfinder +## Project: TAfinder -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. +TAfinder is a desktop resource management application used by NUS SoC professors to choose TAs from a large pool of applicants. 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 the `attach` command. + * What it does: allows the user to attach files to TA applicants to store additional data about them (e.g. resume, transcript). + * Justification: This feature allows the users to avoid needing to copy and paste information from files submitted by the applicants into the comments field of each TA applicant, instead attaching them directly. This saves the users a lot of time and effort. + * Highlights: This enhancement required an understanding of how Java interacts with users' filesystems. The implementation was challenging as there were many corner cases to deal with when interacting with the filesystem, so there had to be additional tests added to cover them. -* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. +* **New Feature**: Added the `import` command. + * What it does: allows the user to attach files to TA applicants to store additional data about them (e.g. resume, transcript). + * Justification: This feature allows the users to avoid needing to manually transfer the details of all the TA applicants from mySoC to TAfinder. Instead, the users can simply export the data from mySoC and import it directly into TAfinder. + * Highlights: Parsing the CSV file format was a challenge. This enhancement required figuring out a way of reading the order of the columns in the CSV file, so as to correctly interpret the data contained within it. -* **Code contributed**: [RepoSense link]() +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=ravern&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByAuthors&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=ravern&tabRepo=AY2324S1-CS2103T-W10-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false) * **Project management**: - * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub + * Managed releases `v1.2` - `v1.4` (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]()) + * Update the GUI to include a detailed view of an applicant (Pull request [\#90](https://github.com/AY2324S1-CS2103T-W10-1/tp/pull/90)) + * Added the ability to store and show previous module grade and an arbitrary interview score (Pull requests [\#100](https://github.com/AY2324S1-CS2103T-W10-1/tp/pull/100)) * **Documentation**: * User Guide: - * Added documentation for the features `delete` and `find` [\#72]() - * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() + * Added documentation for the features `attach` and `import` + * Added the automatic numbering of headings and table of contents generation (Pull request [\#187](https://github.com/AY2324S1-CS2103T-W10-1/tp/pull/187)) * 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]()) + * Added implementation details of the `attach` and `import` feature * **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}_ + * Integrated a Github plugin (CodeCov) to the team repo From 50165e2dd2ec70471592f248f1140948077b4c18 Mon Sep 17 00:00:00 2001 From: Ravern Koh Date: Sat, 11 Nov 2023 19:30:18 +0800 Subject: [PATCH 2/2] Fix headings due to numbering --- docs/team/amosting.md | 2 +- docs/team/lheng1.md | 2 +- docs/team/nabonitasen.md | 2 +- docs/team/ylyma.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/team/amosting.md b/docs/team/amosting.md index dd29f0abe24..4c0d277753b 100644 --- a/docs/team/amosting.md +++ b/docs/team/amosting.md @@ -2,7 +2,7 @@ title: Amos' Project Portfolio Page --- -### Project: TAfinder +## Project: TAfinder TAfinder is a desktop address book application used by SOC professors to choose TAs from a large pool of applicants. 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. diff --git a/docs/team/lheng1.md b/docs/team/lheng1.md index 67044f58169..a3b08e94107 100644 --- a/docs/team/lheng1.md +++ b/docs/team/lheng1.md @@ -2,7 +2,7 @@ title: Heng Yi's Project Portfolio Page --- -### Project: TAfinder +## Project: TAfinder TAfinder is a desktop resource management application used by NUS SOC professors to choose TAs from a large pool of applicants. 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. diff --git a/docs/team/nabonitasen.md b/docs/team/nabonitasen.md index 7adf255a1a2..c2d45496165 100644 --- a/docs/team/nabonitasen.md +++ b/docs/team/nabonitasen.md @@ -2,7 +2,7 @@ title: Nabonita's Project Portfolio Page --- -### Project: TAfinder +## Project: TAfinder TAfinder is a desktop address book application used by SOC professors to choose TAs from a large pool of applicants. 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. diff --git a/docs/team/ylyma.md b/docs/team/ylyma.md index 9f8d2296a04..043c59485f9 100644 --- a/docs/team/ylyma.md +++ b/docs/team/ylyma.md @@ -2,7 +2,7 @@ title: John Doe's Project Portfolio Page --- -### Project: TAfinder +## Project: TAfinder TAfinder is a desktop resource management application used by NUS SOC professors to choose TAs from a large pool of applicants. 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.