Project: EduTrack

Overview

EduTrack is a powerful desktop app designed for SOC tutors, allowing you to streamline your teaching tasks and effortlessly track your student records.

The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 11 kLoC.

Summary of Contributions

Given below are my contributions to the project.

Code contributed: RepoSense link

Enhancements implemented:

  1. Adding a class

  • What it does: This feature allows users to add a new class to the class list.

  • Justification: This feature plays a role as a must-have feature because the ability to add classes is fundamental in EduTrack.

  • Highlights: This enhancement helps users manage multiple classes in EduTrack. Once the new class is added successfully, EduTrack's GUI will automatically update the class list display.

  • Pull request: #34

  1. Editing a class

  • What it does: This feature allows users to edit various attributes of an existing class, including its name, memo, and schedule.

  • Justification: This feature significantly enhances the user experience as it offers a convenient way to rectify any mistakes made while entering class information.

  • Highlights: This enhancement helps users keep class information remains up-to-date and accurate.

  • Pull request: #59

Contributions to the UG:

  • Added documentation for the features adding a class and editing a class: Pull request #61
  • Modified existing documentation of Miscellaneous features: Pull request #86
  • Added the following sections: Command Parameters, EduTrack's Graphical User Interface: #139
  • Contributed in standardising language use and enhance formatting: Pull request #86, #155

Contributions to the DG:

  • Described the implementation of the feature adding a class: Pull request #61
  • Added activity diagram, object diagram and sequence diagram of the feature adding a class: : Pull request #61
  • Added target user profile, user stories, value proposition and non-functional requirements: Pull request #26
  • Added use cases for the features adding a class and editing a class: Pull request #26

Other contributions:

  • Team-based tasks: Recorded product demos for v1.2 and v1.3.
  • Community: PRs reviewed (with non-trivial review comments): #154, #153, #152, #151