Zheng ZiKang's Project Portfolio Page
- 1. New Feature
- 2. Code contributed
- 3. Project management
- 4. Enhancements to existing features
- 5. Documentation
- 6. Community
Project: Mr. Agent
Mr. Agent is a desktop app for managing contacts, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Mr. Agent can get your contact management tasks done faster than traditional GUI apps.
Given below are my contributions to the project.
1. New Features
- New Feature: Added Add/Delete/Edit/List Insurance Commands that allows the user to manage the Insurances.
(Pull requests #29,
#35, #36,
#44, #74)
- What it does: allows the target users (insurance agents) to manage their insurances on the app by saving/editing/deleting insurance details including title and price.
- Justification: This feature makes the product much more complete because insurance is an important part for insurance agents to memorize all the details.
- Highlights: This enhancement is made extensible such that it is easy to add more attributes to describe an insurance if necessary, which does not require massive change to the code base.
- New Feature: Added Sort records Commands that allows the user to sort the records by start/end date in ascending/descending order.
(Pull request #91)
- What it does: allows users to sort the records list in ascending/descending order by start/end date.
- Justification: Record are usually time-sensitive, it is important to provide a quick way for user to prioritize and visualize almost expired records or newest records.
- Highlights: This enhancement is implemented such that more sorting options could be made available easily with minor modification, if any ordering of the list is deemed to be meaningful for the users. For example, sort records between certain period.
- New Feature: Added clear command that allows the user to clear all the data (AddressBook, RecordBook, InsuranceBook and AppointmentBook). (Pull requests #83)
2. Code contributed
3. Project management
- Maintained repo Pull Requests and Issue Tracker in GitHub.
- Managed releases
v1.3
-v1.5
(3 releases) on GitHub. - Setting up the GitHub team org/repo
- Formatted user/developer docs and added table of contents
- Helped team members to debug
- Hosted Weekly meeting
- Helped team to improve code style and quality
- Set up and update project track documentation
4. Enhancements to existing features
- Redesigned and improved the GUI interface (Pull requests #44, #46, #74, #116)
- Improved and extended the command syntax more user-friendly and to match project scenario. (Pull request #24)
- Wrote additional tests for existing and new features to increase coverage (Pull requests #65, #91)
5. Documentation
- User Guide:
- Developer Guide:
- Updated implementation details of the Storage component (Pull requests #98)
- Added implementation details of the Sort Records Commands (Pull requests #98, #108)
- Added implementation details of the Click event feature (Pull requests #98)
- Updated project scope and Use case (Pull request #24)
- Added user stories for the insurances feature (Pull request #98)