Skip to content

Commit

Permalink
Shorten PPP
Browse files Browse the repository at this point in the history
  • Loading branch information
@kevin9foong
kevin9foong committed Nov 8, 2021
1 parent e3a1640 commit d67abc3
Showing 1 changed file with 22 additions and 33 deletions.
55 changes: 22 additions & 33 deletions docs/team/kevin9foong.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,45 +12,37 @@ friends to win competitive games with. <br>
Given below are my contributions to the project.

#### New Features
1. Add Friend functionality (mostly implemented in [PR #68](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/69)) <br>
1. Add Friend functionality ([PR #68](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/69)) <br>
**What it does**: Allows users to add friends to the gitGud friends list.<br>
**Justification**: Core functionality for users to store list of friends.
2. Edit Friend functionality (mostly implemented in [PR #93](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/93)) <br>
2. Edit Friend functionality ([PR #93](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/93)) <br>
**What it does**: Allows users to edit friend's name.<br>
**Justification**: Allows user to update friend's name without having to re-create friend which
requires user to re-provide the previous information of the deleted friend when adding again which can be tedious.
3. Add Game functionality (mostly implemented in [PR #68](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/69)) <br>
**Justification**: Allows user to update friend's name without having to re-create friend and having to re-provide same information.
3. Add Game functionality ([PR #68](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/69)) <br>
**What it does**: Allows users to add games to the gitGud games list.<br>
**Justification**: Core functionality for users to store list of games.
4. Implemented Storage support for Friends and Games (mostly implemented in [PR #68](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/69)) <br>
**What it does**: Allows friends and games data to be stored across multiple application runs by storing data in JSON files on the hard drive.
**Justification**: This allows our application to fulfill its main objective of being able to record friends' gaming information.<br>
5. Add friend skill functionality (mostly implemented in [PR #102](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/102)) <br>
4. Implemented Storage support for Friends and Games ([PR #68](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/69)) <br>
**What it does**: Allows friends and games data to be stored across multiple application runs by storing data in JSON files on the hard drive. <br>
**Justification**: Allows users to store gaming information permanently without having to re-enter each time gitGud is used.<br>
5. Add friend skill functionality ([PR #102](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/102)) <br>
**What it does**: Allows user to store and update friends' skill at different games.<br>
**Justification**: Core functionality which allows our application to record friends' skill values at specific games, so they can keep track of and remember the most-highly skilled friends to play with.
6. Friend recommendation functionality [PR #153](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/153)) <br>
**Justification**: Core functionality for users to keep track of and remember the most-highly skilled friends to play with.
6. Friend recommendation functionality ([PR #153](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/153)) <br>
**What it does**: Recommends friends for user to play with for a given game and given time based on highest skill value of friend.<br>
**Justification**: Core functionality which solves target user's problem of finding optimal friends to play with that both fits into their busy schedules and
**Justification**: Core functionality which helps users find optimal friends to play with that both fits into their busy schedules and
is the most skilled.

#### Testing
1. Wrote unit/integration tests achieving >96% lines and 100% method coverage for:
1. Storage component.
2. Add Friend and Add Game functionalities.
3. Edit Friend functionality (including integration testing with Model component).
4. Add Friend Skill functionality.
5. Recommend functionality (for example, integration tests which ensures recommend works with e.g. list command in succession)
6. Manual testing and highlighting of bugs and reporting of issues observed in application, UG and DG. ([Issues raised and resolved](https://github.com/AY2122S1-CS2103T-W13-4/tp/issues?q=is%3Aissue+author%3Akevin9foong+is%3Aclosed))
7. Discovery of testing bugs with Schedule tests which use shared mutable references to the same Friend instance (fixed in [PR #153](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/153/files))
1. Wrote unit/integration tests achieving >96% lines and 100% method coverage for Storage component, Add Friend,
Add Game, Add Friend Skill and Recommend functionality (including e.g. integration tests which ensures recommend works with list command in succession)
2. Manual testing and reporting of bugs in application, UG and DG. ([Issues raised and resolved](https://github.com/AY2122S1-CS2103T-W13-4/tp/issues?q=is%3Aissue+author%3Akevin9foong+is%3Aclosed))
3. Discovery of testing bugs (e.g. schedule tests which use shared mutable references) ([PR #153](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/153/files))

#### Contribution to team based tasks
1. Project-wide refactoring of codebase to adapt AB3 to gitGud's needs (mostly implemented in [PR #45](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/45)). <br>
* **What it involves**:
* Refactoring of Persons and Tags to Friends and Games classes for team usage.
* Updating of relevant test cases
* **Justification**: Provides a base for our team to extend and develop gitGud specific features on top of.
* Refactoring of Persons and Tags to Friends and Games classes and updating of test cases.
2. Setting up of tools
1. Integrated the Github plugin (codecov) to the team repo.
1. Integrated the GitHub plugin (codecov) to the team repo.
3. Miscellaneous tasks:
1. Set up initial project website.
2. Initial set up for team repo & organization.
Expand All @@ -60,23 +52,20 @@ Given below are my contributions to the project.
[RepoSense link](https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=kevin9foong&sort=groupTitle&sortWithin=title&since=2021-09-17&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false)

#### Documentation
* User Guide (UG) (Completed mostly in [PR #209](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/209), [PR #133](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/133) and [PR #45](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/133)):
* User Guide (UG) ([PR #209](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/209), [PR #133](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/133) and [PR #45](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/133)):
1. Added initial documentation for the features `add friend`, `add game`, `delete game` and
`link game and friend`.
2. Added documentation for `edit`, `add friend skill` and `recommend` features.
3. Overhauled UG to make it more conversational and directed to target user.
4. Added icons/symbols, command constraints and warnings to each user command.
5. Added the user guide structure, glossary, application UI overview and FAQ sections.
* Developer Guide (DG):
1. Added the value proposition for gitGud.
1. Added the value proposition of gitGud
2. Added use case for `add friend`.
3. Highlighting of bugs related to Use Case Extension numbering. [Issue #243](https://github.com/AY2122S1-CS2103T-W13-4/tp/issues/243)
4. Highlighting of UML diagram bugs (one example is delete and schedule sequence diagrams for reference frames) [Issue #251](https://github.com/AY2122S1-CS2103T-W13-4/tp/issues/251)
5. Added documentation for Storage component (including the UML class diagram).
6. Added documentation for `recommend` command implementation (including the UML activity diagram and sequence diagrams).
3. Highlighting of bugs (e.g. Use Case Extension numbering ([Issue #243](https://github.com/AY2122S1-CS2103T-W13-4/tp/issues/243)) and UML diagram bugs (e.g. bugs with reference frame notation) ([Issue #251](https://github.com/AY2122S1-CS2103T-W13-4/tp/issues/251)))
4. Added documentation for Storage component (including UML class diagram) and `recommend` command implementation (including UML activity and sequence diagrams).
* README:
1. Updated GitHub Actions build status badge and codecov badge.
2. Updated description and organised layout of README.
1. Updated GitHub Actions build status badge and codecov badge, description and layout of README.

#### Review/mentoring contributions (with non-trivial comments)
1. [Ui Recommendations and bugs from Review](https://github.com/AY2122S1-CS2103T-W13-4/tp/pull/107)
Expand Down

0 comments on commit d67abc3

Please sign in to comment.