Skip to content

Commit

Permalink
Merge pull request #234 from yeekian/master
Browse files Browse the repository at this point in the history
Update yeekian PPP
  • Loading branch information
yeekian authored Nov 12, 2024
2 parents 9dcec6d + 861d5ee commit 171ccda
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions docs/team/yeekian.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,36 @@ reading their course.
TutorLink keeps a running tally of grades (GPA, overall score) of each
`Student` by tagging `Components` to each student via a `Grade` object.

TutorLink provides useful summary statistics of a professor's course that
can be further filtered down for analysis.

### Summary of Contributions

- **New Feature:** Added a parser to decipher commands and command arguments from user input strings
- What it does: After being given the user input string, the parser identify the command that the user is trying to execute and returns the command object. The parser will also be able to extract the input arguments for the command from the rest of the string and store them in a HashMap
- What it does: Given a user input string, the parser identifies the command that the user is trying to execute and returns the command object. The parser will also be able to extract the input arguments for the command from the rest of the string and store them in a HashMap
- Justification: This feature allows the sense-making of user input data. It provides a bridge between the user and the other features of the app.


- **New Feature:** Added the command to add and delete grade to components for individual students
- What it does: Allows the user to add grades for individuals for individual graded assessment components one at a time. The added grades can also be individually deleted for a specific student and his/her component via the delete grade command.
- **New Feature:** `add_grade` and `delete_grade` commands:
- What it does: `add_grade` command allows the user to add grades for individuals for individual graded assessment components one at a time. Using the `delete_grade` command, added grades can also be individually deleted for a specific student and his/her component.
- Justification: This feature improves the product significantly because a user needs to be able to record and remove scores of assessment components, such as assignments, for students. This way, the user will be able to keep a record of these grades and use them to calculate their final grade.
- Highlights: The implementation was challenging as it required adherence to the data case when searching for duplicate or existing grades. This was accomplished by standardising the finding functions to check in uppercase.
- Credits: While the processing of input user arguments and the handling of errors are done on my own, the method to add a Grade object into the list of grades, GradeList, was created by @TrungBui32.


- **New Feature:** Added the command to add new components
- What it does: allows the user to add new assessment components.
- **New Feature:** `add_component` command:
- What it does: Allows the user to add new assessment components.
- 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: The command checks for duplicates and prevents additional components from being added.


- **Improved Feature:** `list_grade` command:
- What it does: Prints a list of all the grades of all students and their individual final percentage points.
- Contribution:
- Re-designed output list to be more user-friendly and print the final percentage points for each student.
- Provided 2 options for the command:
1. Print grade for all students
2. Print grade for specific student using the student's MATRIC_NUMBER.
- Justification: This improved feature ensures that grades are presented in a more informative and cleaner manner.


- **Code contributed:** [RepoSense link](https://nus-cs2113-ay2425s1.github.io/tp-dashboard/?search=yeekian&breakdown=true&sort=groupTitle%20dsc&sortWithin=title&since=2024-09-20&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other)


Expand All @@ -45,14 +52,12 @@ can be further filtered down for analysis.
- Wrote tests for `Parser`, `AddGradeCommand`, `DeleteGradeCommand`, and `AddComponentCommand`


- **Documentation:**
- User Guide:
- Wrote initial draft of user guide, including documentation for all basic features [#94](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/94)

- Developer Guide:
- Added implementation details of the AddGradeCommand and DeleteGradeCommand feature. [#106](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/106)
- Wrote appendices: Product Scope, User Stories, Non-Functional Requirements, Glossary, and Instructions for Manual Testing

- **Documentation:**
- **User Guide:**
- Authored the initial user guide draft, including documentation for all basic features [#94](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/94).
- **Developer Guide:**
- Documented implementation details for `AddGradeCommand` and `DeleteGradeCommand` features [#106](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/106).
- Wrote appendices: Product Scope, User Stories, Non-Functional Requirements, Glossary, and Instructions for Manual Testing.

- **Community:**
- PRs reviewed (with non-trivial review comments): [#25](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/25), [#38](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/38), [#83](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/83), [#101](https://github.com/AY2425S1-CS2113-W13-4/tp/pull/101)
Expand Down

0 comments on commit 171ccda

Please sign in to comment.