PROJECT: ProManage

Overview

This project portfolio documents my contributions to the development of the CS2113 project, as part of my team T16-2.

Summary of contributions

  • Major enhancement: added the ability to find events using keywords events via the findEvent command

    • What it does: allows the user to search for an event using some keywords.

    • Justification: This feature is important as it allows users to access the required events quickly if they know its name or some parts of description.

  • Minor enhancement:

    • Created the test cases for classes of findEvent command

    • Updated the documentation

    • Created the event sorting function

  • Code contributed: [Functional code]

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.

Searching for the events using keywords: findEvent

Priority level: all

Finds events whose names contain any of the given keywords or whose description contains any of the given keywords (case-insensitive).
Format: findEvent KEYWORD [MORE_KEYWORDS] Example:

  • findEvent Meeting Weekly

  • The search is case insensitive

  • The order of the keywords does not matter. e.g. Weekly Meeting will match Meeting Weekly

  • Only full words will be matched

  • Events matching at least one keyword will be returned

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.

Find Event feature

Current Implementation

The findEvent allows the user to search for an event using some keywords. It searches for such events which contain at least one of keywords in their names or description.

Execution of Command

Given below is an example usage scenario and how the findEvent mechanism works.

Step 1. The user inputs findEvent meeting to find the event containing the word meeting in its name or description.

Step 2. The command is parsed and the result is shown.