Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 3.39 KB

Chia Le Jing.adoc

File metadata and controls

56 lines (37 loc) · 3.39 KB
Raw

Chia Le Jing - Project Portfolio

PROJECT: Medeina

Overview

Medeina is a desktop application primarily designed for veterinarians and their assistants (henceforth referred to as user/s) to better manage their contacts, pet patient and appointments details. The main bulk of interactions that the user will have with Medeina is through the Command Line Interface (CLI). However, it also has a Graphical User Interface (GUI) created with JavaFX so that users can visualise the data easily. Medeina is written in Java, and has about 20 kLoC.

Summary of contributions

  • Major enhancement: Implemented edit command

    • What it does: Allows the user to edit contacts, pet patients and appointments in Medeina. Relevant dependencies are also resolved as well. For example, if the user wishes to edit the name of a pet patient, the pet patient’s name entry under the owner and also its relevant list of appointments will be updated to reflect the new name.

    • Justification: Editing the details of contacts, pet patients and appointments is critical to the workflow of our users. This is because certain details might have been keyed in wrongly at the time of entry, and our users will want to modify these details to ensure the accuracy of their data in Medeina. The resolution of dependencies is also vital to the operation of Medeina, as it gives users the freedom to edit contacts, pet patients and appointments as they require without upsetting the relations between these objects.

    • Highlights: some highlight

  • Minor enhancement: Wrote PetPatient and all its relevant classes (PetPatientName, Species, Breed, Colour and BloodType). This enhancement is critical to the operation of Medeina, as most commands make use of PetPatient objects.

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

  • Other contributions:

    • Project management:

      • Managed release v1.5rc (1 release) on GitHub

    • Enhancements to existing features:

      • Some enhancement

    • Documentation:

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

    • 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, 4, 5)

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.