Project: CodeSphere

CodeSphere is a desktop student management app, optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). It is an app targeted at Teaching Assistants (TAs) in the National University of Singapore (NUS) School of Computing (SoC).

Given below are my contributions to the project.

  • New Feature: Sort student list by name or performance tag.
    • What it does: The sort command allows the user to specify a sort criteria and sorts the student list accordingly. The supported enum sort criteria are TAG and NAME.
    • Justification: The ability to display all students in a specified order can be helpful to Teaching Assistants (TAs) in many situations. For example, sorting by tag allows TAs to easily analyse students’ performance while sorting by name allows for a more organised student list for easier reference. Overall, sorting improves the user experience by enabling flexible data organisation.
    • Highlights: The sort feature can be combined with the find feature, meaning the user is able to apply a sort criteria on a filtered list, or filter a sorted list.
  • New Feature: List students with a non-empty pending question field.
    • What it does: This feature allows the user to find and list all students within a course whose pending question field is not empty.
    • Justification: As TAs might sometimes be overwhelmed by the number of questions, some questions may get overlooked. Therefore, listing all students with unanswered questions is essential for TAs to keep track of which questions they have yet to address, and ensures that TAs can provide timely responses and support to students.
  • New Feature: Reset student list.
    • What it does: The reset command is used after sorting or filtering the student list, to restore the student list to its original state where all students in a course are ordered chronologically by when they were added.
    • Justification: After filtering or sorting the student list, the displayed student list might be altered. The user should therefore have a way to restore the student list to its initial state. This feature is essential for maintaining data integrity, ensuring that users can always revert to the original student list to prevent data loss or confusion.
  • Enhancements to existing features:
    • Adapted AB3’s original add person command to be used in CodeSphere as the command to add a student into a course (PR #65).
    • Added summary statistics for each course in the course list to show the total number of students in that course, the number of students with non-empty pending question fields, and the number of students who are tagged as GOOD, AVERAGE and POOR. (PR #94, #135).
    • Added new tests and modified existing tests (PR #241, #253, #256, #260, #261, #262).
  • Code contributed: RepoSense link
  • Team-tasks:
    • Set up the GitHub team organisation and repository.
    • Set up Codecov in the team repository (PR #36).
  • Community:
    • Reviewed PRs, and suggested improvements for things like Javadoc style and code quality.
    • Reported bugs for team CS2103T-T15-4 during PE-D and suggested possible improvements.
  • Documentation:
    • User Guide:
      • Added documentation for the features list and reset (PR #293).
      • Improved documentation quality for the all sections in the UG (PR #363, #381).
    • Developer Guide:
      • Described the implementation of the sort command (PR #349) and created the sequence and activity diagrams (PR #350).
      • Added user stories, use cases and non-functional requirements (PR #316).
      • Added instructions for manual testing (PR #332).