Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 4.28 KB

ongyz.adoc

File metadata and controls

76 lines (53 loc) · 4.28 KB

Ong Yan Zhi - Project Portfolio

PROJECT: TutorHelper

Overview

TutorHelper is a desktop administration application intended for Tutors who would like to organise their students' information. TutorHelper uses CLI(command-line interface) as its main form of inputs: where tutors issues commands in the form of successive line of text. Having multiple students at once can be a hassle to deal with, especially with each student having his own curriculum, tuition timing, and payments. Our team of five decided to create TutorHelper by building upon the existing AddressBook Level 4 application. TutorHelper offers an easy way to keep track of the tutor schedule and keep tabs on the students, allowing him to efficiently plan ahead.

Some of the new main features include :
Grouping
Payment
Earnings
Add/Edit/Delete/Mark Syllabus
Add/Delete/Copy subject

This project portfolio consists of the contributions I have made to TutorHelper.

Summary of contributions

  • Major enhancement: added the ability to edit existing syllabus entries

    • What it does: allows the user to edit existing syllabus entries.

    • Justification: Curriculum of subjects taught in schools change constantly, a tutor could update syllabus of a subject whenever there are changes and the app should provide a convenient way to edit them.

    • Highlights: Editing syllabus entries will cause changes in the database. The use of the editsyll command ensures that all other fields of student remains unedited.

  • Major enhancement: added the ability to edit existing payment entries

    • What it does: allows the user to edit existing payment entries using the same paid command.

    • Justification: Students could pay fees in installments or weekly instead of monthly, as such tutors may need to constantly edit payment entries for the month and the app should provide a convenient way to edit them.

    • Highlights: Editing payment entries will cause changes in the database. The use of the paid command looks for existing payment entries with the same month and year.

  • Minor enhancement:

    • Updating of test cases for new changes

    • XmlClasses for data writing into xml files for storage (Pull request #14)

  • Code contributed: https://nus-cs2103-ay1819s1.github.io/cs2103-dashboard/#=undefined&search=ongyz

  • Other contributions:

    • Project management:

      • Created issues for the different milestones and labelled them according to the severity and priority on Github.

    • Enhancements to existing features:

      • Create max capacity of payment entries tracked (Pull request #73)

      • Update existing tests for changes in existing commands (Pull requests #141, #149, #220, #243)

      • Wrote additional tests for new features added to increase code coverage (Pull requests #126, #141)

    • Documentation:

      • Added section for editsyll and editing using paid in the User Guide (Pull requests #156)

      • Added section for editsyll and editing using paid in the Developer Guide (Pull requests #95, #129)

    • Community:

      • Reviewed other PRs

      • Reported bugs and suggestions for other teams in the class

Contributions to the User Guide

Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users.

Contributions to the Developer Guide

Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.