Ong Chin Hang - Project Portfolio Page

Overview

revisED is a CLI application to help students revise by allowing them to create flashcards, take quizzes, and keep track of their deadlines, tasks and any other important dates. It is written in Java.

Summary of Contributions

• Code contributed: RepoSense link

• Features implemented:

  • Storing of data in the form of nested folders and files for easier navigation and manual changes by the users.
    • This was challenging because a lot of testings needed to be done to make sure the hierarchy was created as intended, as compared to storing all data to one place.
    • Credit: the methods for storing and loading tasks are taken from JiaLerk, though with quite some modifications to improve on them. (Pull requests: #83)
  • Loading of the saved data
    • loading the data stored in this way posed challenges because the user can make a lot more variation of changes to the stored data, as compared to storing all data in one file. Thus, a lot of exception handling needed to be done to make sure the application still works with corrupted data.
  • Exporting of all data to one Json file for the use of other applications.

• Enhancements implemented:

  • Enhanced the code to reduce redundancy and improve design. (Issues: #29 #33 #26)
  • Included Result data to storage, which was not in consideration. (Pull requests: #42)
  • Modified Storage class to use builder design pattern for less error prone instance creation. (Pull requests: #47)

• Contributions to the UG:

  • Export feature command.
  • Explanation to storing, loading and exporting of data.
  • Restructuring of features section, adding of symbols legend to the introduction, improvement on quick start. (Pull requests: #126)

• Contributions to the DG:

  • Storage section under design (along with its class diagram).
  • Storing, loading, and exporting data sections under implementation (along with all the sequence diagrams contained in them).
  • List section and its class diagram.
  • Logging section.
  • Restructuring of whole DG; improvement on setting up the project section, testing, user stories, non-functional requirements, manual testing. (Pull requests: #142 #129)

• Contributions to team-based tasks:

  • Maintained the issue tracker - opening and assigning of most issues.
  • Setup the logging configuration. (Pull requests: #51)
  • Enhanced the code to reduce redundancy and improve design. (Issues: #29 #33 #26)
  • Restructured DG and UG and revamped/enhanced common sections such as introduction, user stories, manual testing, etc. (Pull requests: #142 #129 #127 #126)

• Review/mentoring contributions: Pull requests: #151 #146 #124 #86 #82 #52 #141 #32 #12 #69 #54