Yong Gi Roh's Project Portfolio Page
Project Overview: Networkers
Overview
Networkers 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.
Below are my contributions to the project.
Summary of my contributions
- Code contributed: My Contribution
- Pull Requests created by me: PR
Enhancements implemented:
listProc
Command- Added test cases
- Handle UI-related problems and enhancements
- Divided the UI into two columns, one for Clients and another for Procedures
- Display the whether a Procedure is completed
- Mark and Unmark Command
- Allowed users to mark and unmark a procedure as complete
- Reflect changes in
completed
field of the Procedure
- JsonAdaptedProcedure
- Created the JsonAdaptedProcedure to store Procedures as a json
- Single-worded Command Parsing and Validation
- Prevented single-worded commands like
help
andexit
to throw error messages
- Prevented single-worded commands like
Contributions to the UG
- Section: View All Clients:
list
- Section: View All Procedures of a Client:
listProc
- Added an overview of the method
- Added sequence diagram and design consideration
- Small Sections: Clear, Exit
- Command Summary Table Maintenance
Contributions to the DG
- Section: List Procedures By Client (ListProc)
- Architecture sequence diagram maintenance
- User stories for
list
andlistProc
Command - Some Non-Functional Requirements (NFR)
- Section: Appendix updated to match current version
Contributions to team-based tasks
- Created team repository and setup GitHub pages with Jekyll
- Participated in weekly meetings to receive & provide feedback and decide next steps
Review/mentoring contributions
Excerpts from DG
- ListProc Sequence Diagram:
- Colors for Component Managers: