Project: ProfBook
ProfBook is a desktop application used for easy management of a variety of tasks, students and groups.
The user interacts with it using a CLI, and has a GUI created with JavaFX.
ProfBook is written in Java, and has about 20 kLoC.
Given below are my contributions to the project.
Code contributed:
Click here to my RepoSense Report.
New features:
touch
command:
- What it does: Adds students into the different directories of ProfBook swiftly.
- Justification: Enhances user's experience by providing a straightforward and easy method for adding students.
- Highlights: Provides a simple and streamlined process of adding a student.
rm
command:
- What it does: Removes students or groups through a single command.
- Justification: This simplifies user interactions, ensuring simplicity and efficiency.
- Highlights: Utilizes a single dynamic command to provide a streamlined means of removing students or groups.
todo
command:
- What it does: Creates task with only a description for specific student(s) or group(s) within ProfBook.
- Justification: This feature improves the product significantly because a user can now easily track tasks assigned.
- Highlights: Ability to assign todo tasks to a large number of students or groups simultaneously, reducing the time and effort required for manual input.
deadline
command:
- What it does: Creates task with a deadline for specific student(s) or group(s) within ProfBook.
- Justification: This feature improves task management as users can now track assigned tasks with deadlines.
- Highlights: Ability to assign deadline tasks to a large number of students or groups simultaneously, reducing the time and effort required for manual input.
Project Management
- Managed the closing of milestones for v1.3.
- Recorded the demo video for v1.3.
- Updated User Guide aspects that are not specific to any feature.
- Assisted in the recording of final demo video.
- Non-Feature Aspects for User Guide:
- ProfBook Command Format.
- Navigating the Graphical User Interface(GUI).
- FAQ.
- Overall editing and formatting of the whole UG to ensure consistency in writing.
- Non-Feature Aspects for Developer Guide:
- Proofread and gave constructive feedback on areas of improvement.
Documentation
User Guide:
- Feature Aspects:
touch
command. rm
command. unmark
command.
Developer Guide:
- Feature Aspects:
- Wrote and created UML for the following sections of Implementation,
- Creating a task: adding tasks for all or specific student or group.
- Editing information: editing a student's or group's details.
- Here are some PRs I reviewed (with non-trivial review comments):
- Contribution to forum discussions: