HireMe v1.6

HireMe v1.6 Release Notes

Release Date: 11 November 2024

---

Overview

HireMe v1.6 focuses on refining the user experience by addressing bugs and updating documentation. This release ensures greater reliability and ease of understanding with improvements across the User Guide and Developer Guide.

---

Changes

Documentation Enhancements

1. User Guide Updates

   • Improved clarity and consistency in command instructions and examples.
   • Added more visualisation with images
   • Added instructions for running the application on Mac and Windows and terminal.
   • Added glossary
   • Added troubleshooting for setting up and using HireMe
   • Added known issues

2. Developer Guide Updates

   • Updated UML diagrams to reflect recent changes, ensuring diagrams align with the current application state.
   • Revised documentation on testing methodologies for improved clarity.
   • Added acknowledgements
   • Added new use cases and updated user stories based on recent feature improvements.
   • Expanded the manual testing steps section to include recent bug fixes, ensuring comprehensive guidance for developers.
   • Added planned enhancements

---

HireMe v1.6 provides a smoother, more dependable experience by addressing user feedback and refining core functionalities. We encourage users to explore the improved documentation and share their feedback for continuous improvement.

HireMe v1.5

HireMe v1.5 Release Notes

Release Date: 7 November 2024

---

Overview

HireMe v1.5 enhances the internship application tracking experience with visual insights, improved UI, and increased testing coverage, making it easier to manage applications efficiently. This release introduces a new chart feature, UI improvements, and comprehensive testing updates to ensure smoother functionality.

---

Features

New Changes/Features

1. Status Chart Feature

   • Users can now view a pie chart summarizing the statuses of their internship applications, providing a visual snapshot of application progress.

   • This feature opens a new window displaying the chart, making it easy to monitor the status distribution across applications.

   • Command:

     /chart
     

2. Enhanced User Interface

   • Improved UI elements for better readability and ease of use, including updated layouts and status indicators.
   • Visual refinements make the app more intuitive and engaging, allowing users to view status updates and application data seamlessly.

3. Bug Fixes

   • Resolved issues from v1.4, including:
     • Accurate status UI updates upon modification of internship application status.
     • Fixed inconsistencies in error messages for invalid commands.
     • Corrected date validation issues to prevent adding future-dated applications.
     • Fixed bug preventing users from typing in multiple extra arguments
     • Fixed bugs where the error messages were not useful in explaining the reason users' input was invalid
     • Fixed bug where an internship application with today's date was not allowed to be added

4. Documentation Updates

   • Updated User Guide and Developer Guide with introduction, new features, examples, and command usage.
   • Updated User Guide and Developer Guide with table of contents.
   • Refined documentation layout for easier navigation and added detailed explanations for commands and features.
   • Updated UML diagrams to reflect the new chart functionality and revised UI changes.
   • Added activity diagram for updating the status of an internship application.
   • Update use cases and user stories.
   • Added steps to carry out manual testing for each of the command.
   • Updated about us and portfolio pages.

5. Expanded Testing and Code Coverage

   • Added comprehensive test cases for new and existing features to improve code robustness and reliability.
   • Increased code coverage across major functionalities to prevent regressions and ensure feature stability.

6. Improved code quality

• Added logging and defensive programming to ensure better debugging and fewer chances of bugs.

---

We hope these enhancements will provide users with a more intuitive and feature-rich experience in managing their internship applications. We welcome feedback to help us make HireMe even better!

HireMe v1.4

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.

     

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.

HireMe v1.3

HireMe v1.3 Release Notes

Release Date: 17 October 2024

---

Overview

HireMe v1.3 is the initial 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

Core Functionality

1. Add Internship Applications
   • Users can add internship applications by specifying the company name, role, email, and application date.
   • Example:

     /a n/Google r/Software Engineer Intern e/[email protected] d/16/09/24
     

2. List All Applications
   • Users can list all internship applications in the system.
   • Example:

     /list
     

3. Find Applications by Company Name Prefix
   • Users can search for applications by specifying the prefix of the company name.
   • Example:

     /f Met
     

   • This will return all applications where the company name starts with "Met", such as Meta.

4. Delete Internship Applications
   • Users can delete specific internship applications by specifying their index in the list.
   • Example:

     /d 1
     

5. Clear All Applications

   • Users can clear all stored internship applications at once.
   • Example:

     /clear
     

6. Help Command

   • A help command is available to provide information on how to use the system.
   • Example:

     /help
     

7. Autoload

   • The application automatically loads previously saved data when it starts, so users can resume where they left off without manual intervention.

8. Autosave

   • The application automatically saves any changes made to the data, so there’s no need for a manual save.

---

Known Issues

• No edit functionality: Currently, there is no option to modify an existing internship application after it has been added. Users need to delete and re-add the application if changes are required.

---

Future Improvements

• Edit Command: Future releases will introduce the ability to modify existing applications.
• Enhanced Search: Search capabilities will be expanded beyond company name prefixes to include role and tags.

---

This version is the first step toward a comprehensive internship management tool. We hope to gather feedback to further improve the user experience and functionality.