Yan BingTao's Project Portfolio Page
Project: tCheck
tCheck is a desktop application that offers an integrated system to efficiently manage a bubble tea shop, of the (imaginary) brand T-sugar, by providing sales tracking, ingredient tracking and manpower management. It is optimized for CLI users to update and retrieve the information more efficiently.
Given below are my contributions to the project.
-
Code contributed: RepoSense link
- Project management:
- Managed Pull Requests on GitHub’s team repository
-
Added archive feature: Allows user to archive a single/all employees’ contact information by using commands,
c-archive
orc-archive-all
, respectively. (Pull Request: #66, #77) -
Added unarchive feature: Allows user to unarchive a single employee’s contact information by using commands
c-unarchive
. (Pull Request: #76) -
Added list-all-archived-employees feature: Allows user to see a list of all archived employees. (Pull Request: #67)
-
Added find-today’s-available-manpower feature: Allows user to see a list of today’s available employees. (Pull Request: #141)
-
Added find-tomorrow’s-available-manpower feature: Allows user to see a list of tomorrow’s available employees. (Pull Request: #141)
-
Added find-tag feature: Allows user to find all the matched employees whose tag(s) contains the given keyword(s). (Pull Request: #141)
-
Implemented
salesbook
storage: can save the sales record data insalesbook
in json format and read it back. (Pull Request: #96) -
Implemented calendar-pane in GUI: can show a calendar for the current month. (Pull Request: #135)
-
Separated the main pane to 4 panes: can display sales record data, ingredient tracking data, employees’ contact info, and a calendar independently. (Pull Request: #89)
- Enhancements to existing features:
- Contributions to team-based tasks:
- Changed the product icon (Pull Request: #89)
- Changed the main window title name to our product name (Pull Request: #154)
- Maintained all meeting minutes and contributed to set meeting agenda before each meeting.
- Managed all Pull Requests in team repository (by adding correct labels, linking to correct milestone, linking to correct issues if any).
- PRs reviewed (with non-trivial review comments): #20, #24, #105, #168, #169, #254, #257
- Documentation:
- AboutUs page:
- Updated my information in the AboutUs page of the project website.
- User Guide:
- Added documentation for the features
c-archive
,c-archive-all
,c-archive-list
,storage
in v1.1. (Pull Request: #27, #112) - Added table-of-contents and internal links in v1.1. (Pull Request: #36)
- Added documentation for the features
c-unarchive
in v1.3. (Pull Request: #112) - Added documentation for the features
c-today
,c-tomorrow
,c-tag-find
in v1.3. (Pull Request: #145) - Added documentation for feature
calendar
and edited documentation for the featuresc-today
,c-tomorrow
,c-tag-find
,c-archive
,c-archive-all
,c-archive-list
,storage
in v1.4. (Pull Request: #252)
- Added documentation for the features
- Developer Guide:
- Added documentation for Non-functional requirements of the product under Appendix: Requirements in v1.1. (Pull Request: #26)
- Added documentation (explanations, sequence diagrams, activity diagrams, class diagrams, etc) for the features
c-archive
,c-unarchive
,c-archive-all
in v1.3. (Pull Request: #99) - Added documentation and edited the class diagram for UI component, Storage component under Design in v1.4. (Pull Request: #253)
- Added documentation and the class diagram for
Person
sub-component in Model component under Design in v1.4. (Pull Request: #253) - Edited use cases (UC01 & UC02) based on our implementation under Appendix: Requirements in v1.4. (Pull Request: #253)
- Added documentation for manual testing (“Archiving an employee” section) under Appendix: Instructions for manual testing in v1.4. (Pull Request: #253)
- AboutUs page: