Gan Jia Lerk - 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

• Enhancements implemented:

  • Did up the base code for the project for easier development #12

  • Implemented most SubjectCommand features which includes:

    • JavaDoc in subjectcommand package excluding QuizSubjectCommand and ResultSubjectCommand which are from Muthu
    • All classes under the subjectcommand package excluding ExportSubjectCommand which is from Chin Hang, and QuizSubjectCommand and ResultSubjectCommand which are from Muthu
    • Logging in classes in subjectcommand package
    • Assertions in classes in subjectcommand package

  • Implemented some methods in the Ui class which includes:

    • All relevant Subject Error messages as well as printing all subject related methods in Ui

  • Implemented exceptions which includes:

    • All exceptions in the subjectexception package
    • FailedParserException
    • Reformat all exceptions to output error messages instead of printing the errors straight #53
    • Changed the structure of exceptions and added some exceptions the other exception packages #52

  • Implemented almost all the test cases under the command package which includes:

    • FlashcardCommandTest
    • SubjectCommandTest but the storage component of setup was inspired by Chin Hang
    • TaskCommandTest
    • TopicCommandTest #168 and #128

  • Implemented most assertions in Ui class

• Contributions to documentation:

  • Did the Main level features
  • Did the restructuring of the UG together with Chin Hang

• Contributions to the DG:

  • Did all the design for the command package, inlcuding diagrams #128
  • Did implementation for 4.7 Adding objects implementation and 4.8 Accessing subjects/topics implementation, including diagrams #159
  • Did the first level of restructuring to the DG #86
  • Did the base part of design in card package which was later done by Herman

• Review/mentoring contributions:

  • Approved and commented on the following pull requests: #172 #158 #150 #129 #127 #126 #125 #88 #75 #59 #38 #22 #21 #11

  • Inspired code for some of the other Classes in the project since the project is based on a level system, and I did the code for the main level.