Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 3.41 KB

Jacqueline Cheong.adoc

File metadata and controls

59 lines (40 loc) · 3.41 KB

Jacqueline Cheong - Project Portfolio

PROJECT: Medeina


Overview

Medeina is a desktop application designed for veterinarians and their assistants to better manage their contacts, pet patient details and appointments. 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.

Summary of contributions

  • Major enhancement: Autocomplete

    • What it does: Provide autocomplete suggestions that come with descriptions to give users an idea of what the option or prefix is used for. Users are also given information such as existing Nric in Medeina and pet patient names as autocomplete suggestions for certain commands.

    • Justification: Medeina’s command syntax involves many options and parameters, which makes it difficult for users to remember. The difficulty in recalling would cause inefficiency in the usage of Medeina. Users of Medeina are expected to handle sensitive information that has little room for errors. By providing autocomplete function for existing data in Medeina, the room for error can be greatly reduced.

    • Highlights: This enhancement requires the exploration of singleton pattern in design and listeners for JavaFX. It involves an in-depth analysis of command syntax and user-input, and in the process, discovered that JavaFX’s textfield caret position is not updated in sync with textfield’s content.

    • Credits: Bug fix for the above mentioned issue

  • Minor enhancement: Support for changing theme that is persistent beyond app restart.

  • Code contributed: [Functional code] [Test code]

  • Other contributions:

    • Project management:

      • Managed releases v1.2 and v1.3 (2 releases) on GitHub

    • Enhancements to existing features:

      • Added a new GUI color scheme (Pull requests #156, #188)

    • Documentation:

      • Did cosmetic tweaks to existing contents of the User Guide: #214

    • Community:

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

      • Reported bugs and suggestions for other teams (examples: #170, #179)

    • Tools:

      • Integrated a new Github plugin (CircleCI) to the team repo #207

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.