Skip to content

Commit

Permalink
Update PPP
Browse files Browse the repository at this point in the history
  • Loading branch information
yyyaohhh committed Nov 14, 2023
1 parent 85d31f3 commit 6063c0e
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
[[portfolio](team/yyyaohhh.md)]

- Role: Developer
- Responsibilities: UI
- Responsibilities: Commands
50 changes: 30 additions & 20 deletions docs/team/yyyaohhh.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,54 @@

## Project ModCraft

ModCraft is a desktop application built for students from National University of Singapore (NUS) to help them **track and organise their academic journey**. With ModCraft serving as your **personal study planner**, you can easily:

ModCraft is an app that provides a fast and easy way for NUS students to track courses
to take to meet graduation requirements and plan courses to take. The user interacts
with it using a Command Line Interface (CLI), and it has a Graphic User Interface (GUI) created with JavaFX.
* Keep track of the courses you have taken
* Plan ahead to fufill graduation requirements
* Continously adjust your study plan to new changes

And much more!

ModCraft streamlines the stressful process of course planning by providing a seamless user experience. It is tailored for efficiency through a Command Line Interface (CLI), complemented by the convenience of a Graphical User Interface (GUI) developed using JavaFX.

Given below are my contributions to the project.

- **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=yyyaohhh&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos)

- **Project management**:

- to be added soon
- Involved in managing releases on GitHub.

- **Enhancements to existing features**:
- **Enhanced and new features**:

- `delete` command: deletes a module from the semester lists if it exists.
- `calculateCAP` command: calculates the Cumulative Average Point (CAP) of all valid modules in the module planner, using their grades and modular credits.
- `calculateMC` command: calculates the total sum of Modular Credits (MCs) of all modules in the module planner, regardless of their grades.
- `delete` command: allows users to delete a module from the module plan only if it exists.
- Justification: This feature improves the product significantly because a user can make mistakes in adding modules and ModCraft should provide a way for them to rectify them.
- `calculateCAP` command: allows users to calculate the Cumulative Average Point (CAP) of all valid modules in the module plan easily, using their grades and modular credits.
- Justification: This feature improves the product significantly because calculating and knowing the CAP is very important to NUS students, as it is used in many areas.<br>
e.g. Calculating CAP for Semester Exchange Programs (SEP) and application for scholarships.
- `calculateMC` command: allows users to calculate the total sum of Modular Credits (MCs) of all modules in the module plan, regardless of their grades.
- Justification: This feature improves the product significantly because calculating and knowing the MCs is very important to NUS students, as it is used in many areas.<br>
e.g. Calculating MCs for Semester Exchange Programs (SEP) and checking for graduate requirements.
- Wrote additional test cases: [#227](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/227)

- **Documentation**:

- User Guide:
- Description of ModCraft.
- Description of the `edit` command and other commands.
- FAQ.
- Glossary
- General details: [#223](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/223), [#227](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/227), [#230](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/230)
- Description of ModCraft: [#245](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/245)
- Description of the `edit` command and other commands: [#245](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/245)
- FAQ: [#245](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/245)
- Glossary. [#245](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/245)
- Formatting of the User Guide: [#258](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/258), [#260](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/260)
- Developer Guide:
- Implementation details of the `delete` command, `calculateCAP` command and `calculateMC` command.
- Instructions for manual testing.
- Implementation details of the `delete` command, `calculateCAP` command and `calculateMC` command: [#245](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/245)
- Instructions for manual testing: [#237](https://github.com/AY2324S1-CS2103T-T13-0/tp/pull/237)

- **Community**:

- PRs reviewed (with non-trivial review comments): 4
- Contributed to forum discussions .
- Contributed to forum discussions:
- [answered questions posted by peers](https://github.com/nus-cs2103-AY2324S1/forum/issues/256).
- [asked questions](https://github.com/nus-cs2103-AY2324S1/forum/issues/132).
- Reported bugs and [suggestions](https://github.com/nus-cs2103-AY2324S1/forum/issues/309) for other teams in the class.

- **Tools**:
- asked questions: [#132](https://github.com/nus-cs2103-AY2324S1/forum/issues/132), [#193](https://github.com/nus-cs2103-AY2324S1/forum/issues/132), [#130](https://github.com/nus-cs2103-AY2324S1/forum/issues/130), [#26](https://github.com/nus-cs2103-AY2324S1/forum/issues/26)
- Reported bugs and suggestions for other teams in the class: [#309](https://github.com/nus-cs2103-AY2324S1/forum/issues/309)

- to be added soon

0 comments on commit 6063c0e

Please sign in to comment.