Releases: AY2425S1-CS2103T-T08-3/tp
v1.6
Final Release Notes
This final release brings an extensive series of improvements, bug fixes, and formatting enhancements to ensure the project's stability and usability. Given the comprehensive updates included here, further releases are unlikely unless special circumstances arise.
What's Changed
-
Documentation Improvements
- Updated and refined
index.md
with additional tips and corrections. - Fixed formatting issues across multiple documents, including Quick Start hyperlinks and UG inconsistencies.
- Enhanced clarity in both the User Guide (UG) and Developer Guide (DG) by fixing typos, adjusting wordings, and refining diagrams.
- Integrated consistent page dividers and formatted sections within the UG for improved readability.
- Updated and refined
-
User Guide (UG) Enhancements
- Addressed various bugs and inconsistencies within the UG, ensuring clarity and accuracy in usage instructions.
- Refined error messages to improve user understanding of invalid commands.
-
Developer Guide (DG) Updates
- Corrected and debugged content in the DG, including the addition of clearer diagrams and updated descriptions.
-
Codebase Modifications
- Updated command keywords (e.g.,
PATIENT_ID
toID
in delete commands) for a more intuitive user experience. - Made minor adjustments to
Messages.java
and other files to align with documentation updates.
- Updated command keywords (e.g.,
This release aims to deliver a polished, user-friendly final product, integrating both user feedback and extensive internal testing to ensure the highest standard.
Full Changelog: v1.5...v1.6
What's Changed
- Change index.md by @chengzihao123 in #211
- Fix bugged formatting, include new tips by @Nigeltzy in #215
- Fix formatting issues by @Nigeltzy in #216
- Fix quickstart hyperlinks by @Nigeltzy in #217
- Fix quick start hyperlink by @Nigeltzy in #218
- Fix UG Bugs by @sandyk0105 in #315
- User Guide Bug Fixing by @tyxiangs in #317
- Fix typo by @chengzihao123 in #318
- Remove TAG from MedDict by @sandyk0105 in #319
- Fix DG bugs by @chengzihao123 in #320
- DG debugging by @chengzihao123 in #323
- Fix Diagrams by @chengzihao123 in #324
- Fix wordings by @chengzihao123 in #325
- Fix raised bugs by @Nigeltzy in #326
- Update invalid command error message by @sandyk0105 in #327
- PE Bug Fixing by @tyxiangs in #322
- Update UG by @Nigeltzy in #328
- Fix UG again by @Nigeltzy in #329
- Test UG formatting by @Nigeltzy in #330
- Include page dividers by @Nigeltzy in #331
- Fix page dividers by @Nigeltzy in #332
- Update UG and Messages.java by @sandyk0105 in #333
- Update UserGuide.md by @sandyk0105 in #334
- Update UserGuide.md by @sandyk0105 in #335
- More changes to DG by @chengzihao123 in #336
- More changes to DG by @chengzihao123 in #337
- More changes to DG by @chengzihao123 in #338
- More changes to DG by @chengzihao123 in #339
- Fix UG inconsistency by @Nigeltzy in #340
- Change PATIENT_ID to ID for delete command by @sandyk0105 in #341
- Edit UserGuide by @shinichi04 in #342
Full Changelog: v1.5...v1.6
v1.5.0
Release Notes for v1.5
Overview
Hello once again! MedDict is back with a fresh new look 😎😎. This release brings substantial improvements and new features, transforming the application into a more full-fledged tool for medical staff and aspiring developers. With an updated and polished User Guide tailored for medical professionals, as well as a Developer Guide for budding developers, this version is set up for practical testing and open-wide feedback. We welcome all observations on bugs, usability, and any potential enhancements.
Key Updates
-
Enhanced Command Functionality:
- Fixed and refined core commands such as
EditPerson
,AddRemarks
,CreatePatient
, andCreateDoctor
. - Improved
DeleteSequenceDiagram
andMarkAppointmentCommandTest
, enhancing both visual and functional consistency. - Modifications to the existing commands for smoother workflow and improved usability.
- Fixed and refined core commands such as
-
Testing Improvements:
- Additional unit tests for
MarkAppointmentCommandTest
andRemarkCommandTest
to ensure robust handling of appointment and remark functionalities. - Created comprehensive command parser tests, especially for Person-related commands, to verify proper parsing of user inputs.
- Additional unit tests for
-
User Interface and Usability Enhancements:
- Updated visual elements across the application, improving readability and layout.
- Fixed multiple formatting and CSS errors to ensure a smoother user experience.
- Added indicators to distinguish completed and incomplete appointments.
-
Documentation Updates:
- User Guide: Expanded with a detailed Quick Start guide for medical staff, refining instructions to enhance accessibility and ease of use.
- Developer Guide: Updated to include manual testing instructions, UML modifications, and a refined architecture sequence diagram, aiding developers in navigating the codebase.
-
Logging and Assertions:
- Enabled assertions and added extra logging for better debugging and error tracking.
-
Code Quality Enhancements:
- Refactored code to enhance maintainability, readability, and overall quality.
Known Areas for Testing
This release is primed for extensive testing. Feedback on the following would be particularly valuable:
- Command Parsing: Ensure accuracy and intuitive handling of all commands, especially around Person and Appointment commands.
- UI Feedback: Evaluate usability, visual consistency, and whether indicators for appointment statuses improve user experience.
- Documentation Clarity: Verify if the updated guides are sufficiently clear and helpful, especially for new users and developers.
Full Changelog
For a comprehensive list of all changes in this release, please visit v1.5 Changelog.
We look forward to your insights and bug reports!
Special thanks to everyone who has worked to rush out v1.5.0
What's Changed
- Fix print by @Nigeltzy in #125
- Modify Existing Architecture Sequence Diagram by @chengzihao123 in #126
- Enable Assertion by @chengzihao123 in #124
- Update ModelClassDiagram.puml by @Nigeltzy in #128
- UML Modification by @tyxiangs in #132
- MarkAppointmentCommandTest: add unit test for marking appointments by @tyxiangs in #135
- Add extra Logging by @chengzihao123 in #127
- Update DeleteSequenceDiagram by @sandyk0105 in #130
- Update UserGuide.md by @sandyk0105 in #139
- RemarkCommandTest: add unit test for remark functionality by @tyxiangs in #137
- Branch user guide update feature by @tyxiangs in #141
- Modify existing commands by @chengzihao123 in #143
- Update user guide by @tyxiangs in #144
- Update UserGuide (detailed quick start) by @shinichi04 in #148
- Update Current User Guide by @sandyk0105 in #158
- Update UG by @sandyk0105 in #170
- Fix EditPerson , AddRemarks, CreatePatient and CreateDoctor Commands by @chengzihao123 in #162
- Fix CreateP, CreateD and Delete Commands by @chengzihao123 in #171
- Branch alpha bug fix appointment by @tyxiangs in #174
- More test cases for parsers by @chengzihao123 in #176
- Developer Guide Update by @tyxiangs in #177
- Modify DG and UG by @chengzihao123 in #180
- Update website by @Nigeltzy in #181
- Update table format by @Nigeltzy in #182
- 178 update ug by @Nigeltzy in #183
- Update bugs by @Nigeltzy in #184
- Update formatting errors by @Nigeltzy in #187
- Test formatting by @Nigeltzy in #188
- Update UG formatting by @Nigeltzy in #189
- Add DG manual testing by @shinichi04 in #175
- User Guide Update by @tyxiangs in #185
- Update formatting by @Nigeltzy in #190
- Update visual elements by @Nigeltzy in #193
- Code Quality Changes by @chengzihao123 in #192
- Update visual elements by @Nigeltzy in #194
- Update Getting Started in UG by @Nigeltzy in #197
- Create Command Parser Tests for Person-related Commands by @sandyk0105 in #196
- Fix remaining formatting errors by @Nigeltzy in #201
- Fix css by @sandyk0105 in #204
- Refine UG by @Nigeltzy in #205
- Fix formatting errors by @Nigeltzy in #207
- Fix bugs by @chengzihao123 in #203
- Indicate Completed/Incompelte Appointments by @sandyk0105 in #209
Full Changelog: v1.4...v1.5
Release Notes v1.5.1
This update includes minor improvements and fixes to enhance the website's usability and readability. Here’s what’s been changed:
Summary of Changes
- Updated
index.md
for content improvements. - Corrected several formatting issues to ensure consistent styling across pages.
- Improved Quick Start section by fixing hyperlinks for easier navigation.
- Added new tips to aid users in understanding features better.
These updates streamline the user experience with minor bug fixes and formatting enhancements, ensuring a smoother interaction with the site.
Full Changelog: v1.5...v1.5.1
What's Changed
- Change index.md by @chengzihao123 in #211
- Fix bugged formatting, include new tips by @Nigeltzy in #215
- Fix formatting issues by @Nigeltzy in #216
- Fix quickstart hyperlinks by @Nigeltzy in #217
- Fix quick start hyperlink by @Nigeltzy in #218
Full Changelog: v1.5...v1.5.1
v0.1.1-alpha
Release Notes: Alpha Version
We are excited to announce the release of the Alpha Version of our project! This release introduces new features, improvements, and bug fixes to enhance the user experience and code structure. This version should be able to serve as a standalone product with its updated storage updating and retrieving capabilities, storing patients, doctors, and all appointments within your local device's storage. Besides that, here’s what’s new:
🆕 What's New
-
Class Logic and Storage Enhancements:
-
Commands and Parsers:
-
Testing and Bug Fixes:
-
UI Improvements (#115):
- Modified the UI to simplify testing and improve usability
- UI now displays role of persons and their ID on their screen to remove the need for getId() command, however, that command is still available to users.
Full Changelog: Compare changes between v0.1 and v1.4
This version includes essential improvements and lays the groundwork for smoother development and better user experience. Thank you to all contributors for making this release possible!
Full Changelog: https://github.com/AY2425S1-CS2103T-T08-3/tp/commits/alpha
What's Changed
- Modify the Person class logic by @chengzihao123 in #93
- Modify storage logic by @chengzihao123 in #94
- Unfactor patient doctor by @Nigeltzy in #97
- Add appointments to doctors by @Nigeltzy in #102
- Branch check appointment command modification by @tyxiangs in #114
- 101 modify the UI for easier application testing by @sandyk0105 in #115
- Add test for CreateDoctorCommand execution success by @tyxiangs in #109
- Add MarkAppointmentCommand and Parser. by @shinichi04 in #116
- Revert "Add MarkAppointmentCommand and Parser." by @sandyk0105 in #118
- CreatePatientCommandTest: Add tests for patient creation by @tyxiangs in #111
- Revert "Revert "Add MarkAppointmentCommand and Parser."" by @sandyk0105 in #122
- ViewHistoryCommandTest by @tyxiangs in #120
- Fix MarkAppointmentCommand by @sandyk0105 in #123
- Branch check appointment command test by @tyxiangs in #117
Full Changelog: v0.1...v1.4
This release notes was created with the assistance of GitHub and ChatGPT AI services.
v0.1.0
*Release Notes - Version 0.1.0
New Features
-
Separation of Contacts into Entities
- Contacts are now represented as distinct entities: Patient and Doctor instead of the generic
Person
class. - This allows for better categorization, functionality, and management of different types of contacts.
- Contacts are now represented as distinct entities: Patient and Doctor instead of the generic
-
New Commands to Add Contacts
-
CreatePatientCommand:
Add a new patient to the contact list with relevant details such as:- ID: Automatically generated and assigned.
- Remarks: Optional field to store additional notes about the patient.
- Example usage:
createPatient n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 r/Has diabetes
-
CreateDoctorCommand:
Add a new doctor with attributes:- ID: Automatically generated and unique.
- Remarks: Optional field for additional information.
- Example usage:
createDoctor n/Dr. Alice Tan p/81234567 e/[email protected] a/123, Bukit Timah r/Cardiologist
-
-
ID and Remarks Management
- Both Patient and Doctor contacts now include an automatically generated ID.
- Remarks field is available for both entities to store notes or additional comments.
Class Diagram
Bug Fixes
- Fixed an issue where id values may be mixed between patients and doctors
Known Issues
- There may be numerous commands that are available to use and will prompt with correct output when typed in, however, are not yet ready for proper usage.
How to Upgrade
- Download the latest release package.
- Replace the existing application files with the new version.
- Ensure any previous data files (e.g.,
addressbook.json
) are backed up to avoid conflicts with new storage formats.
Example Usage:
Adding a new contact to the address book beyond a person, and instead adding using the createPatient command.
Usage of new getId command, used to keep track of the unique identities of the patients and doctors as well as indicate the time at which they were added to the address book.
What's Changed
- Add individual photo (Nigel) by @Nigeltzy in #20
- Add axel's photo by @shinichi04 in #22
- Add photo to images directory by @sandyk0105 in #23
- Branch add photo by @tyxiangs in #21
- Tutorial adding command by @tyxiangs in #12
- Update AboutUs for Sandy by @sandyk0105 in #32
- Update AboutUs.md for Nigel by @Nigeltzy in #30
- Edit AboutUs for Axel by @shinichi04 in #29
- Update AboutUs page for course admin purposes by @tyxiangs in #31
- Add Zi Hao's photo by @chengzihao123 in #33
- Modify AboutUs.md by @chengzihao123 in #35
- Update Ui.png and index.md by @Nigeltzy in #38
- Update website by @Nigeltzy in #39
- Modify the developer guide by @chengzihao123 in #41
- 42 update read me by @Nigeltzy in #44
- Update project website by @chengzihao123 in #45
- Modify Project Title by @chengzihao123 in #46
- Branch add doctor by @tyxiangs in #48
- Project website by @chengzihao123 in #49
- Add a History class by @chengzihao123 in #51
- Improve History.java by @sandyk0105 in #54
- 43 extend person patient doctor by @Nigeltzy in #52
- 56 update base classes by @Nigeltzy in #59
- Add toString functionality and update generics for Appointment.java by @Nigeltzy in #66
- Add deleteAppointment Command by @chengzihao123 in #69
- Add addAppointment Command by @chengzihao123 in #67
- History class: refactor appointment handling and formatting by @tyxiangs in #65
- Add CreatePatientCommand by @sandyk0105 in #71
- Add AddNotes Command by @sandyk0105 in #77
- Branch view history by @tyxiangs in #75
- Modify addAppointment and deleteAppointment Classes by @chengzihao123 in #79
- CheckAppointmentCommand: add new command for appointment checks by @tyxiangs in #80
- Add command and parser for delete patient. by @shinichi04 in #81
- 76 add test coverage apt patient doctor by @Nigeltzy in #82
- Add test cases for AddAppointment Command and add GetId Command by @chengzihao123 in #83
- Remove duplicate methods by @chengzihao123 in #86
- Add CreateDoctorCommand by @Nigeltzy in #91
- The ViewHistoryCommand lacked sufficient unit tests to verify its fun… by @tyxiangs in #88
- Fix buggy commands by @chengzihao123 in #92
New Contributors
- @Nigeltzy made their first contribution in #20
- @shinichi04 made their first contribution in #22
- @sandyk0105 made their first contribution in #23
- @tyxiangs made their first contribution in #21
- @chengzihao123 made their first contribution in #33
Full Changelog: https://github.com/AY2425S1-CS2103T-T08-3/tp/commits/alpha