From 82d2a3eb8ebacfccd66d4dea34799231312dab39 Mon Sep 17 00:00:00 2001 From: Kelvin Neo <2332196+kelvneo@users.noreply.github.com> Date: Thu, 4 Nov 2021 18:55:22 +0800 Subject: [PATCH 1/3] Add Project Portfolio page --- docs/team/kelvneo.md | 65 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/docs/team/kelvneo.md b/docs/team/kelvneo.md index ab75b391b8..38a5e6e5da 100644 --- a/docs/team/kelvneo.md +++ b/docs/team/kelvneo.md @@ -1,6 +1,69 @@ -# John Doe - Project Portfolio Page +# Kelvin Neo - Project Portfolio Page ## Overview +TermiNUS is a CLI (command line interface) program for NUS students who wish to consolidate their +NUS academic needs such as schedules, questions and notes for the modules that they are taking. +With TermiNUS, it aims to aid students and improve their learning experiences while studying in NUS. ### Summary of Contributions + +- **New Feature:** Added `question` which is the ability to add, delete, list and test the user +with questions. + - What it does: It provides the user a way of storing and managing their questions, as well as + running an Active Recall session to test themselves on their own knowledge. + - Justifications: `question` was built to allow users to test themselves using the techniques of + Active Recall, which aims to improve their knowledge and memory of the subject. + - Highlights: The `test` feature includes a timer that indicates how long the user took to answer + each question. The Active Recall portion will also tweak the frequency of the questions appearing + based on the feedback the user gives. For example, if the user deems the question as hard, the + question would appear more often, and if the user deems the question easy, the question would + appear less often. +- **New Feature:** Added `TerminusLogger` + - What it does: `TerminusLogger` wraps around `java.util.logging.Logger` and provides helper + methods that calls the internal `Logger` methods. + - Justifications: To provide a unified and simpler logging experience for the entire application, + `TerminusLogger` was created to prevent duplicate Logger initialization code. It also disables + logging to terminal, and logs only to a file by default. + - Highlights: It provides a wrapper function that can print the stack trace into the logger for + `WARNING` and `SEVERE` cases. +- **New Feature:** Added `help` and `exit` command. + - What it does: `help` and `exit` commands are basic commands to enable the user to view the + commands in the current workspace and exit the program respectively. + - Justifications: `help` must print the commands that exist within the specific workspace to + prevent the user from being confused and running the commands in the wrong places. The `exit` + command is placed at every workspace to allow the user to quit any time, regardless of which + workspace they are in. +- **New Feature:** Added `Terminus` and `Ui` + - What it does: `Terminus` is the main class that runs the main loop of the entire application. + `Ui` class handles all input and output from the user. +- **Code Contributed:** [RepoSense Link](https://nus-cs2113-ay2122s1.github.io/tp-dashboard/?search=kelvneo&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-25&tabOpen=true&tabType=authorship&tabAuthor=kelvneo&tabRepo=AY2122S1-CS2113T-T10-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false) + + +- **Documentation:** + - README.md: + - Included short writeup on how TermiNUS works: [#107](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/107) + - Added badges on various DevOps: [#107](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/107) + - User Guide: + - Documented section on Questions: [#107](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/107) + - Reorganized User Guide based on feedback from PE-D and tutor: [#189](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/189) + - Developer Guide: + - Documented section on Questions: [#107](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/107) + - Documented section on Ui: [#133](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/133) + - Documented sections on Documentation, Logging, Testing, and DevOps: [#184](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/184) + - Added acknowledgements and necessary headers for Developer Guide: [#184](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/184) +- **Team-based Tasks**: + - Tracked the deadlines and schedules of deliverables + - Maintaining the issues and PR trackers + - Increased code coverage: [#56](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/56), + [#68](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/68), + [#84](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/84), + [#102](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/102), + [#117](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/117), + [#186](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/186) + - Added GSON as a library for main data storage: [#70](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/70) +- **Beyond Project Team Tasks:** + - Reported bugs for another team in PE-D: [PE-D Issues](https://github.com/kelvneo/ped/issues) + - Reviewed other teams' User Guide and Developer Guide. +- **Tools:** + - Integrated [Codecov](https://codecov.io) for code coverage tracking: [#110](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/110) From 9821676ee5fbe8c93828b781dfae6f6e7abad88b Mon Sep 17 00:00:00 2001 From: Kelvin Neo <2332196+kelvneo@users.noreply.github.com> Date: Thu, 4 Nov 2021 19:11:50 +0800 Subject: [PATCH 2/3] Update links of AboutUs --- docs/AboutUs.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 3665e3091e..6dc7cd0601 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -2,8 +2,8 @@ Display | Name | Github Profile | Portfolio --------|:----:|:--------------:|:---------: - | Kelvin Neo | [Github](https://github.com/kelvneo) | [Portfolio](docs/team/kelvneo.md) - | Louis | [Github](https://github.com/LouisLouis19) | [Portfolio](docs/team/johndoe.md) -| Tan Juen Woo | [Github](https://github.com/woolicious98) | [Portfolio](docs/team/johndoe.md) - | Schuyler Tay | [Github](https://github.com/3m0W33D) | [Portfolio](docs/team/johndoe.md) + | Kelvin Neo | [Github](https://github.com/kelvneo) | [Portfolio](team/kelvneo.md) + | Louis | [Github](https://github.com/LouisLouis19) | [Portfolio](team/louislouis19.md) +| Tan Juen Woo | [Github](https://github.com/woolicious98) | [Portfolio](team/woolicious98.md) + | Schuyler Tay | [Github](https://github.com/3m0W33D) | [Portfolio](team/3m0W33D.md) From a89cf2ccaf54158009db18185f30d19e3f0f0c11 Mon Sep 17 00:00:00 2001 From: Kelvin Neo <2332196+kelvneo@users.noreply.github.com> Date: Thu, 4 Nov 2021 19:17:34 +0800 Subject: [PATCH 3/3] Change Overview of PPP --- docs/team/kelvneo.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/team/kelvneo.md b/docs/team/kelvneo.md index 38a5e6e5da..5d6e0619d8 100644 --- a/docs/team/kelvneo.md +++ b/docs/team/kelvneo.md @@ -2,9 +2,9 @@ ## Overview -TermiNUS is a CLI (command line interface) program for NUS students who wish to consolidate their -NUS academic needs such as schedules, questions and notes for the modules that they are taking. -With TermiNUS, it aims to aid students and improve their learning experiences while studying in NUS. +TermiNUS is a CLI (command line interface) program for NUS Students who wish to consolidate their +NUS academic materials such as zoom links, questions and notes for the modules that they are taking. +It is written in Java, and has about 12 kLoC. ### Summary of Contributions @@ -40,6 +40,7 @@ with questions. - **Code Contributed:** [RepoSense Link](https://nus-cs2113-ay2122s1.github.io/tp-dashboard/?search=kelvneo&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-25&tabOpen=true&tabType=authorship&tabAuthor=kelvneo&tabRepo=AY2122S1-CS2113T-T10-2%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false) + - **Documentation:** - README.md: - Included short writeup on how TermiNUS works: [#107](https://github.com/AY2122S1-CS2113T-T10-2/tp/pull/107)