From 86c018c987e8d6ed3a634fa3acca270a4297e214 Mon Sep 17 00:00:00 2001 From: tanshiyu Date: Wed, 4 Oct 2023 09:04:05 +0800 Subject: [PATCH 01/10] Change photo name --- docs/images/{shiyu.png => tanshiyu1999.png} | Bin 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/images/{shiyu.png => tanshiyu1999.png} (100%) diff --git a/docs/images/shiyu.png b/docs/images/tanshiyu1999.png similarity index 100% rename from docs/images/shiyu.png rename to docs/images/tanshiyu1999.png From bf88fa223095499e111edfd7b187b681ac6cf50a Mon Sep 17 00:00:00 2001 From: tanshiyu Date: Wed, 4 Oct 2023 09:09:04 +0800 Subject: [PATCH 02/10] Change AboutUs --- docs/AboutUs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/AboutUs.md b/docs/AboutUs.md index f6dd0ade1c9..c6d5b3b4e20 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -38,7 +38,7 @@ We are a team based in the [School of Computing, National University of Singapor ### Shi Yu - + [[github](https://github.com/tanshiyu1999)] [[portfolio](team/tanshiyu1999.md)] From 2399b4c54f0b30af1afbcc87251af9d259dc1aa2 Mon Sep 17 00:00:00 2001 From: CJ-Lee01 Date: Wed, 4 Oct 2023 12:31:56 +0800 Subject: [PATCH 03/10] Add command line syntax requirements --- docs/DeveloperGuide.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 878869ffdec..1f171459337 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -316,12 +316,30 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli ### Non-Functional Requirements +**Generic user requirements** 1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed. 2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. 3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. 4. A user with familiarity with common Unix/Linux shell command syntax should find the syntax of SJ++ to match their habits and easy to pick up. 5. The command syntax should not conflict with something that a user could plausibly use as legitimate data input. +**Command syntax requirements** +1. Names of commands are to be short and simple. +2. Names of commands are to be lowercase. +3. Names of commands are singular. +4. Names of commands should only contain alphabets. +5. Names of commands should only be 1 word long. (i.e. no commands like `add_note`) +6. Names of commands should not be confused with other commands. (e.g. `empty` and `clear`) + +**Argument syntax requirements** +1. Names of arguments are to be short and simple. +2. Names of arguments are to be lowercase. +3. Arguments in the command line are to be preceded by a double dash `--`. (e.g. to use the argument `email`, users must type `--email` as part of the arguments) +4. Names of arguments can be multiple words long if necessary, and the words are separated by underscores. (e.g. `start_time`) +5. Ordering of arguments do not matter in the command line. +6. The argument should carry the same meaning across different commands. + + *{More to be added}* ### Glossary From 2ab124ae72075d70ae23217434c3aeb385b7afca Mon Sep 17 00:00:00 2001 From: CJ-Lee01 Date: Wed, 4 Oct 2023 12:37:49 +0800 Subject: [PATCH 04/10] Add single character argument syntax requirements --- docs/DeveloperGuide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 1f171459337..557e9249094 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -336,6 +336,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli 2. Names of arguments are to be lowercase. 3. Arguments in the command line are to be preceded by a double dash `--`. (e.g. to use the argument `email`, users must type `--email` as part of the arguments) 4. Names of arguments can be multiple words long if necessary, and the words are separated by underscores. (e.g. `start_time`) +5. Names of arguments can be shortened to a single character if used frequently, but still must support the full argument name. (e.g. `--name` can be shortened to `--n` if used frequently, but `--name` must still be supported) 5. Ordering of arguments do not matter in the command line. 6. The argument should carry the same meaning across different commands. From 30eb332aa54d82f1c64fe198f19377df8ad1dbfc Mon Sep 17 00:00:00 2001 From: CJ-Lee01 Date: Wed, 4 Oct 2023 12:42:13 +0800 Subject: [PATCH 05/10] Fix ordering of argument requirement list --- docs/DeveloperGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 557e9249094..e301aba9165 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -337,10 +337,10 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli 3. Arguments in the command line are to be preceded by a double dash `--`. (e.g. to use the argument `email`, users must type `--email` as part of the arguments) 4. Names of arguments can be multiple words long if necessary, and the words are separated by underscores. (e.g. `start_time`) 5. Names of arguments can be shortened to a single character if used frequently, but still must support the full argument name. (e.g. `--name` can be shortened to `--n` if used frequently, but `--name` must still be supported) -5. Ordering of arguments do not matter in the command line. -6. The argument should carry the same meaning across different commands. - +6. Ordering of arguments do not matter in the command line. +7. The argument should carry the same meaning across different commands. +Add single character argument syntax requirements *{More to be added}* ### Glossary From bf292d56a6aef9b1fb0159ef0d851280a328a2d6 Mon Sep 17 00:00:00 2001 From: CJ-Lee01 Date: Wed, 4 Oct 2023 12:43:12 +0800 Subject: [PATCH 06/10] Remove redundant line --- docs/DeveloperGuide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index e301aba9165..2d2ea5824f3 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -340,7 +340,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli 6. Ordering of arguments do not matter in the command line. 7. The argument should carry the same meaning across different commands. -Add single character argument syntax requirements *{More to be added}* ### Glossary From 1f22d8b7b5465007a11bcd358bade06cf093508d Mon Sep 17 00:00:00 2001 From: CJ-Lee01 Date: Wed, 4 Oct 2023 12:55:46 +0800 Subject: [PATCH 07/10] Add command and argument definition into glossary --- docs/DeveloperGuide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 2d2ea5824f3..df8eb2e2e9b 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -345,6 +345,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli ### Glossary * **Mainstream OS**: Windows, macOS, Linux, Unix +* **Commands**: A set of keywords that defines the operations the user wishes to execute. +* **Arguments**: A set of keywords that defines the type of data the user wishes to pass into the command line. -------------------------------------------------------------------------------------------------------------------- From a87d364bd3c23ca5ccc97c28d3accafdae960c9d Mon Sep 17 00:00:00 2001 From: CJ-Lee01 Date: Wed, 4 Oct 2023 17:28:58 +0800 Subject: [PATCH 08/10] Remove syntax NFR --- docs/DeveloperGuide.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index df8eb2e2e9b..a55a7e8c817 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -316,29 +316,12 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli ### Non-Functional Requirements -**Generic user requirements** 1. Should work on any _mainstream OS_ as long as it has Java `11` or above installed. 2. Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. 3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. 4. A user with familiarity with common Unix/Linux shell command syntax should find the syntax of SJ++ to match their habits and easy to pick up. 5. The command syntax should not conflict with something that a user could plausibly use as legitimate data input. -**Command syntax requirements** -1. Names of commands are to be short and simple. -2. Names of commands are to be lowercase. -3. Names of commands are singular. -4. Names of commands should only contain alphabets. -5. Names of commands should only be 1 word long. (i.e. no commands like `add_note`) -6. Names of commands should not be confused with other commands. (e.g. `empty` and `clear`) - -**Argument syntax requirements** -1. Names of arguments are to be short and simple. -2. Names of arguments are to be lowercase. -3. Arguments in the command line are to be preceded by a double dash `--`. (e.g. to use the argument `email`, users must type `--email` as part of the arguments) -4. Names of arguments can be multiple words long if necessary, and the words are separated by underscores. (e.g. `start_time`) -5. Names of arguments can be shortened to a single character if used frequently, but still must support the full argument name. (e.g. `--name` can be shortened to `--n` if used frequently, but `--name` must still be supported) -6. Ordering of arguments do not matter in the command line. -7. The argument should carry the same meaning across different commands. *{More to be added}* From 02bcf1d080878e5209d677faf67b6721551e5ac2 Mon Sep 17 00:00:00 2001 From: "LAPTOP-NQHH6Q7K\\Juanpa" Date: Wed, 4 Oct 2023 20:19:20 +0800 Subject: [PATCH 09/10] Update UG and nomenclature --- build.gradle | 2 +- docs/UserGuide.md | 2 +- docs/tutorials/AddRemark.md | 2 +- src/main/java/seedu/address/model/UserPrefs.java | 2 +- src/test/data/JsonUserPrefsStorageTest/ExtraValuesUserPref.json | 2 +- src/test/data/JsonUserPrefsStorageTest/TypicalUserPref.json | 2 +- src/test/java/seedu/address/logic/LogicManagerTest.java | 2 +- .../java/seedu/address/storage/JsonUserPrefsStorageTest.java | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/build.gradle b/build.gradle index a2951cc709e..ee529dfa9a9 100644 --- a/build.gradle +++ b/build.gradle @@ -66,7 +66,7 @@ dependencies { } shadowJar { - archiveFileName = 'addressbook.jar' + archiveFileName = 'sjobs.jar' } defaultTasks 'clean', 'test' diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3b08641589e..a2a05c35443 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -222,7 +222,7 @@ SJ++ data are saved in the hard disk automatically after any command that change ### Editing the data file -SJ++ data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file. +SJ++ data are saved automatically as a JSON file `[JAR file location]/data/sjobs.json`. Advanced users are welcome to update data directly by editing that data file.
:exclamation: **Caution:** If your changes to the data file makes its format invalid, SJ++ will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. diff --git a/docs/tutorials/AddRemark.md b/docs/tutorials/AddRemark.md index d98f38982e7..4e49a47daaf 100644 --- a/docs/tutorials/AddRemark.md +++ b/docs/tutorials/AddRemark.md @@ -293,7 +293,7 @@ While the changes to code may be minimal, the test data will have to be updated
-:exclamation: You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause AddressBook to default to an empty address book! +:exclamation: You must delete AddressBook’s storage file located at `/data/sjobs.json` before running it! Not doing so will cause AddressBook to default to an empty address book!
diff --git a/src/main/java/seedu/address/model/UserPrefs.java b/src/main/java/seedu/address/model/UserPrefs.java index 6be655fb4c7..75fce7b90e4 100644 --- a/src/main/java/seedu/address/model/UserPrefs.java +++ b/src/main/java/seedu/address/model/UserPrefs.java @@ -14,7 +14,7 @@ public class UserPrefs implements ReadOnlyUserPrefs { private GuiSettings guiSettings = new GuiSettings(); - private Path addressBookFilePath = Paths.get("data" , "addressbook.json"); + private Path addressBookFilePath = Paths.get("data" , "sjobs.json"); /** * Creates a {@code UserPrefs} with default values. diff --git a/src/test/data/JsonUserPrefsStorageTest/ExtraValuesUserPref.json b/src/test/data/JsonUserPrefsStorageTest/ExtraValuesUserPref.json index 1037548a9cd..cba8ce64699 100644 --- a/src/test/data/JsonUserPrefsStorageTest/ExtraValuesUserPref.json +++ b/src/test/data/JsonUserPrefsStorageTest/ExtraValuesUserPref.json @@ -9,5 +9,5 @@ "z" : 99 } }, - "addressBookFilePath" : "addressbook.json" + "addressBookFilePath" : "sjobs.json" } diff --git a/src/test/data/JsonUserPrefsStorageTest/TypicalUserPref.json b/src/test/data/JsonUserPrefsStorageTest/TypicalUserPref.json index b819bed900a..0f2a780eaa8 100644 --- a/src/test/data/JsonUserPrefsStorageTest/TypicalUserPref.json +++ b/src/test/data/JsonUserPrefsStorageTest/TypicalUserPref.json @@ -7,5 +7,5 @@ "y" : 100 } }, - "addressBookFilePath" : "addressbook.json" + "addressBookFilePath" : "sjobs.json" } diff --git a/src/test/java/seedu/address/logic/LogicManagerTest.java b/src/test/java/seedu/address/logic/LogicManagerTest.java index baf8ce336a2..3f578cfb253 100644 --- a/src/test/java/seedu/address/logic/LogicManagerTest.java +++ b/src/test/java/seedu/address/logic/LogicManagerTest.java @@ -46,7 +46,7 @@ public class LogicManagerTest { @BeforeEach public void setUp() { JsonAddressBookStorage addressBookStorage = - new JsonAddressBookStorage(temporaryFolder.resolve("addressBook.json")); + new JsonAddressBookStorage(temporaryFolder.resolve("sjobs.json")); JsonUserPrefsStorage userPrefsStorage = new JsonUserPrefsStorage(temporaryFolder.resolve("userPrefs.json")); StorageManager storage = new StorageManager(addressBookStorage, userPrefsStorage); logic = new LogicManager(model, storage); diff --git a/src/test/java/seedu/address/storage/JsonUserPrefsStorageTest.java b/src/test/java/seedu/address/storage/JsonUserPrefsStorageTest.java index ed0a413526a..8d4f23b424a 100644 --- a/src/test/java/seedu/address/storage/JsonUserPrefsStorageTest.java +++ b/src/test/java/seedu/address/storage/JsonUserPrefsStorageTest.java @@ -73,7 +73,7 @@ public void readUserPrefs_extraValuesInFile_extraValuesIgnored() throws DataLoad private UserPrefs getTypicalUserPrefs() { UserPrefs userPrefs = new UserPrefs(); userPrefs.setGuiSettings(new GuiSettings(1000, 500, 300, 100)); - userPrefs.setAddressBookFilePath(Paths.get("addressbook.json")); + userPrefs.setAddressBookFilePath(Paths.get("sjobs.json")); return userPrefs; } From c060a50d4a370e32993a6d1f55e5dc3222f913c7 Mon Sep 17 00:00:00 2001 From: Wern Date: Wed, 4 Oct 2023 20:30:03 +0800 Subject: [PATCH 10/10] Update log file name --- src/main/java/seedu/address/commons/core/LogsCenter.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/seedu/address/commons/core/LogsCenter.java b/src/main/java/seedu/address/commons/core/LogsCenter.java index 8cf8e15a0f0..33c077dd566 100644 --- a/src/main/java/seedu/address/commons/core/LogsCenter.java +++ b/src/main/java/seedu/address/commons/core/LogsCenter.java @@ -20,7 +20,7 @@ public class LogsCenter { private static final int MAX_FILE_COUNT = 5; private static final int MAX_FILE_SIZE_IN_BYTES = (int) (Math.pow(2, 20) * 5); // 5MB - private static final String LOG_FILE = "addressbook.log"; + private static final String LOG_FILE = "sjobs.log"; private static final Logger logger; // logger for this class private static Logger baseLogger; // to be used as the parent of all other loggers created by this class. private static Level currentLogLevel = Level.INFO;