Project: Realodex
AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
Given below are my contributions to the project.
Feature: Edit
- What it does: allows the user to edit client profiles.
- Justification: Edit feature must be changed every time a new field is added to the client profile, so that users can edit every field of the client profile.
Feature: Delete by index
- What it does: allows the user to delete a client profile by index.
New Feature: Delete by name
- What it does: allows the user to delete a client profile by name.
- Justification: Makes it convenient for users to delete client profiles
Code contributed: RepoSense link
Project management:
- Managed releases
v1.3
- v1.5rc
(3 releases) on GitHub
Enhancements to existing features:
- Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests #36, #38)
Documentation:
- User Guide:
- Added documentation for the features
delete
and edit
#72 - Did cosmetic tweaks to the User Guide
- Fixed bugs in the User Guide
- Developer Guide:
- Added implementation details of the
delete
and edit
feature.
Community:
- PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
- Contributed to forum discussions (examples: 1, 2, 3, 4)
- Reported bugs and suggestions for other teams in the class (examples: 1, 2, 3)
- Some parts of the history feature I added was adopted by several other class mates (1, 2)
Tools:
- Integrated a third party library (Natty) to the project (#42)
- Integrated a new Github plugin (CircleCI) to the team repo
{you can add/remove categories in the list above}