From 1fb3a2a793f53a89ff592236bb98ba4fe7e01de4 Mon Sep 17 00:00:00 2001 From: tahsinhasem Date: Mon, 15 Apr 2024 22:36:01 +0800 Subject: [PATCH 1/3] Added Copilot acknowledgements --- docs/DeveloperGuide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 3e68f058447..656e81a6bfd 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -15,6 +15,8 @@ This Developer Guide (DG) has been adapted from the AB-3 developer guide found [here](https://se-education.org/addressbook-level3/DeveloperGuide.html). +Github Copilot was used throughout the project to assist write Javadocs, Test Cases and implement some methods (by Tahsin, Sarji). + -------------------------------------------------------------------------------------------------------------------- ## **Setting up, getting started** From e902c7b542d820fe6d80f03b244f148714b5e3d0 Mon Sep 17 00:00:00 2001 From: tahsinhasem Date: Mon, 15 Apr 2024 22:49:09 +0800 Subject: [PATCH 2/3] Updated Import Command Feature --- docs/DeveloperGuide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 656e81a6bfd..d5b54113bc3 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -15,7 +15,7 @@ This Developer Guide (DG) has been adapted from the AB-3 developer guide found [here](https://se-education.org/addressbook-level3/DeveloperGuide.html). -Github Copilot was used throughout the project to assist write Javadocs, Test Cases and implement some methods (by Tahsin, Sarji). +GitHub Copilot was used throughout the project to assist write Javadocs, Test Cases and implement some methods (by Tahsin, Sarji). -------------------------------------------------------------------------------------------------------------------- @@ -165,12 +165,13 @@ This section describes some noteworthy details on how certain features are imple #### Implementation -The import feature is implemented through the use of `JsonAddressBookStorage`. Given that the user of the application has a JSON file containing contacts in a format similar to the save file of the application, they will be able to import such contacts by providing the filename of the JSON file. The implementation of the feature is somewhat similar to how the application natively reads its own contact manager data, and as such uses similar functions. +The import feature is implemented through the use of `JsonAddressBookStorage` . Given that the user of the application has a JSON file (containing contacts in a format similar to the save file of the application) or a CSV file (containing contacts in a format similar to how data is exported as a CSV file), they will be able to import such contacts by providing the filename of the JSON or CSV file. The implementation of the feature is somewhat similar to how the application natively reads its own contact manager data, and as such uses similar functions. -This feature implements the following operations, other than the ones it is overriding: +This feature implements the following significant operations, other than the ones it is overriding: * `ImportCommand#retrievePersonsFromFile()`: Retrieves the `Person`s that are read from a given file and inserts them into a list of `JsonAdaptedPerson`. * `ImportCommand#readPersons()`: Reads the `Person`s currently inside the file to be read. This command succeeds only if the application is able to read the file and if the file is in the correct JSON format. +* `ImportCommand#readPersonsFromCSV()`: Reads the `Person`s currently inside the file to be read. This command succeeds only if the application is able to read the file and if the file is in the correct CSV format. This command is implemented in the above manner in order to follow OOP principles more closely, more specifically to prevent any one method from doing too many tasks. Moreover, the reuse of `JsonAddressBookStorage` and other related classes is done in order to aid future development of the feature. Following the same spirit, the logic of this feature is implemented in similar ways to how the application reads its own main save file. From eb80c3ad549d7b22210697132b5d48c273a907bc Mon Sep 17 00:00:00 2001 From: tahsinhasem Date: Mon, 15 Apr 2024 22:58:19 +0800 Subject: [PATCH 3/3] Updated DG Acknowledgements --- docs/DeveloperGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index d5b54113bc3..998c1655eba 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -15,7 +15,7 @@ This Developer Guide (DG) has been adapted from the AB-3 developer guide found [here](https://se-education.org/addressbook-level3/DeveloperGuide.html). -GitHub Copilot was used throughout the project to assist write Javadocs, Test Cases and implement some methods (by Tahsin, Sarji). +GitHub Copilot (autocomplete feature) was used throughout the project to assist write Javadocs, Test Cases and implement some methods (by Tahsin, Sarji). --------------------------------------------------------------------------------------------------------------------