Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 4.17 KB

deborahlow97.adoc

File metadata and controls

76 lines (60 loc) · 4.17 KB

Deborah Low Shi Lei - Project Portfolio

(GitHub)

Welcome to my project portfolio. This document summarises my contributions of every software-related project that I have been involved with. The link to my GitHub page can be found above. This is where you can find the repository of every project mentioned below.

Project: CollegeZone

CollegeZone is a desktop address book application used by National University of Singapore Residential College 4 (RC4) students. We aim to make RC4 student’s school life much easier and more convenient.
The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 20 kLoC.
Code contributed:
Functional code
Test code

Summary of contributions

Major enhancement: added Add, Edit, Sort and Delete goal command

  • What it does: Allows user to add, edit and delete goals into CollegeZone. It also allows user to sort the goals that they have based on the field they want it sorted in. It includes keeping track of when the goals started, ended, it’s importance level to user and it’s completion status.

  • External behavior:
    ../UserGuide.adoc

  • Justification: This feature improves the product significantly because RC4 students will have goals that they want to accomplish in life, especially for new RC4 students, they enter NUS with many goals they want to achieve. Having this feature allows them to record down the goals and track the status of it.

Major enhancement: added Complete and RevertComplete goal command

  • What it does: Allows user to update the completion status of the existing goals they have in CollegeZone.

  • External behavior:
    ../UserGuide.adoc

  • Justification: This feature improves the product significantly because RC4 students will have be able to indicate completion status of goals that they have.

Minor enhancement: added a theme command that allows the user to change the theme colour of CollegeZone.

  • Justification: This feature allows RC4 students to switch to a different theme colour of their liking.

  • External behavior:
    ../UserGuide.adoc

Minor enhancement: added birthday, level of friendship, unit number and ccas field

  • Justification: The addition of this field provides user with more comprehensive contact details to add into CollegeZone.

  • External behavior:
    ../UserGuide.adoc

Proposed enhancements:

  • Adding Sub-goals

  • Adding of timetable into CollegeZone

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.

Other Contributions:

  • Project management:

    • Managed releases v1.3 - v1.4.1 (3 releases) on GitHub *

  • Enhancements to existing features:

    • Updated the GUI color scheme (Pull requests #204)

  • Documentation:

    • Did cosmetic tweaks to existing contents of the User Guide (#198)

  • Community:

    • PRs reviewed (with non-trivial review comments): #12, #32, #19, #42

    • Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)

  • Tools:

    • Integrated a third party library (Natty) to the project (#64)