Skip to content

HireMe v1.4

Compare
Choose a tag to compare
@Raghava-Chittidi Raghava-Chittidi released this 24 Oct 13:53
· 339 commits to master since this release
1382099

HireMe v1.4 Release Notes

Release Date: 24 October 2024


Overview

HireMe v1.4 is the alpha release of the HireMe internship application tracking system, optimized for use via a Command Line Interface (CLI). It allows users to efficiently manage their internship applications while providing the ease of use of a desktop GUI.


Features

New Changes/Features

  1. Status field for internship applications

    • Each internship application now contains a status of the application.

    • The status can be of these values: "PENDING", "ACCEPTED", "REJECTED".

    • Newly created applications would have the default status of "PENDING".

    • The statuses can be modified using the commands mentioned below.

      image

  2. Pending Command

    • Allows users to mark an internship application as pending review with an index number.
    • The index number must be valid (non-negative and smaller than or equal to the total number of internship applications in the list).
    • Example:
      /pending 3
      
      • This marks the third internship application in the list as "Pending."
  3. Accept Command

    • Allows users to mark an internship application as accepted with an index number.
    • The index number must be valid (non-negative and smaller than or equal to the total number of internship applications in the list).
    • Example:
      /accept 2
      
      • This marks the second internship application in the list as "Accepted."
  4. Reject Command

    • Allows users to mark an internship application as rejected with an index number.
    • The index number must be valid (non-negative and smaller than or equal to the total number of internship applications in the list).
    • Example:
      /reject 1
      
      • This marks the first internship application in the list as "Rejected."
  5. Filter by Status Command

    • This feature enables users to filter the internship applications based on their status (e.g., Pending, Accepted, or Rejected).
    • Only 'pending', 'accepted', or 'rejected' filter keywords are allowed.
    • Example:
      /filter pending
      
      • This filters the list and displays all internship applications with the status "Pending."
  6. Sort Command

    • The sort command allows users to sort their internship application list by the earliest (ascending) or latest (descending) application dates.
    • Only 'earliest' and 'latest' sorting order keywords are allowed.
    • Example:
      /sort earliest
      
      • This returns all applications in sorted order from the earliest to the latest application dates.
  7. Testing

    • Added tests to ensure that the sort command correctly sorts the internship applications in the intended order.
    • Added tests to validate date inputs and fixed an issue that allowed users to add internship applications with future dates.
  8. Documentation

    • Documentation has been updated to reflect new commands and features, including detailed examples.
    • Documentation has updated UML diagrams
    • Added more examples and explanations for some of the commands
  9. UI

  • The internship application status can be seen in the UI for each internship application. They are also colour coded to represent the different statuses and also to make the application more visually appealing.

Known Issues

  • Add internship application: Does not currently work with today’s date.
  • Add internship application: Displays the wrong error message when there is additional fields.
  • Add command example in user guide: For example, Facebook has an extra t/ field.
  • Status UI: UI for status does not change immediately if the status of an internship application has been updated.

Future Improvements

  • Use cases and user stories: These need to be improved by adding additional details and steps.
  • Generics: Some of the generic classes need to be cleaned up as the use of generics may be unnecessary.
  • Testing: We want to review and write additional tests for increased coverage as well as for classes that currently do not have sufficient testing.

This version takes a significant step toward offering comprehensive functionality for managing internship applications. We encourage feedback to further improve user experience and feature set.