Skip to content

Latest commit

 

History

History
142 lines (95 loc) · 10.9 KB

khsc96.adoc

File metadata and controls

142 lines (95 loc) · 10.9 KB

Kenny Ho - Project Portfolio

PROJECT: Delino

Overview

Delino is a desktop application for couriers to manage delivery tasks. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 16 kLoC.

Summary of contributions

  • Major enhancement:

    1. Added search feature (Pull request #187)
      Functionality of feature can be found here and implementation of it can be found here.

      • What it does:
        Allows the user to specifically search for keywords that matches any fields of the parcel. The user are also able to narrow down their search range by providing different flags and prefixes.

      • Justification:
        This is one of the key feature of Delino as it allows the user to sieve out parcels of their interest from the large parcels list.

      • Highlights:
        This enhancement is heavily affected by the fields added in parcel. A new field requires an update for Search, hence affecting future implementation. Implementing this feature requires the thorough understanding of the existing class in AB3 such as the ArgumentMultimap and the NameContainsKeywordsPredicate. Furthermore, JavaFX class Predicate was used to achieve functionality of this feature. Moreover, as this features allows user to search in many different possible way, testing the different scenarios are hard. ParametizedTest of JUnit testing was used to make my test code much cleaner.

    2. Updated edit feature (Pull request #234)
      Functionality of feature can be found here and implementation of it can be found here.

      • What it does:
        Allows the user to edit specific fields of a parcel, Order or Return Order.

      • Justification:
        This is one of the key feature of Delino as it allows the user to edit any field in Orders or Return Orders. It is especially important as the user might need to reschedule the delivery date due to unforeseen circumstances.

      • Highlights:
        This enhancement is affected by the design of parcel class. It affects the future implementation of any future features that will alter the parcel design. This feature requires a thorough understanding of the existing code of AB3 such as the ArgumentMultimap class.

  • Minor enhancement:

    1. Improve UI of Delino (Pull requests: #209, #221), #363.

    2. Allow user to easily see the time in Delino by adding a real-time clock (Pull requests: #336).

  • Code contributed: [Functional code & Test code]

  • Other contributions:

    • Project management:

      1. In charge of both code integration and testing.

      2. Finalised the pre-releases and releases of Delino v1.2, v1.3 and v1.4 on github.

    • Enhancements to existing features:

      1. UI changes Pull requests : #209, #221, #363.

      2. Improve search feature and edit feature functionality to cover Return Order as well as coverage of test case and error messages #187, #234, #248, #305.

    • Documentation:

      1. Update Edit feature, Search feature, Quick start, Glossary and minor documentation bugs of User Guide (Pull requests: #91, #92, #128, #135, #177, #195, #227, #316).

      2. Update Use cases 1-6, Product Scope, Image rendering bug, Search feature and Edit feature of Developer Guide (Pull requests: #76, #114, #178, #204, #208, #231, #249, #259, #316).

      3. Added own email in ContactUs, changed title of all documents to match Delino name and Update of own PPP (Pull requests : #80, #92, #321).

    • Community:

    • Tools:

      • Integrated a third party library (Travis) to the project (#8f78de0)

Contributions to the User Guide

Given below are sections that I have contributed to Delino’s User Guide. They showcase my ability to write documentation targeting end-users.

Edit feature

This whole section on Edit feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Search feature

This whole section on Search feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Command summary

This whole section on Command summary can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Contributions to the Developer Guide

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

Edit feature

This whole section on Edit feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Search feature

This whole section on Search feature can be found at here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Use case for Edit

This whole section on Use case for edit feature can be found at UC05 of here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Use case for search

This whole section on Use case for search feature can be found at UC07 of here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Manual Testing - Appendix Edit

This whole section on Manual testing of Edit feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.

Manual Testing - Appendix Search

This whole section on Manual testing of Search feature can be found here. This link is provided in the event if some of the cross links are not working, as they refer to documents done by another team member.