[CS2113T-T09-1] ConTech #24

marcusbory · 2021-09-29T13:56:39Z

ConTech is a Command Line Interface (CLI) app for people in the computing industry (who prefer CLI) to manage computing-related contacts. It is optimised for CLI users so that they are able to access their contacts' information (ie Github ID, LinkedIn profile, Email, etc) quickly using commands.

docs/DeveloperGuide.md

siyuancheng178 · 2021-10-27T04:18:33Z

docs/DeveloperGuide.md

+`Contact`.
+
+
+## <a name="implementation"></a>Implementation


i think for each functionality, adding some sample inputs & outputs is much clear?

Mick609

Maybe you could use more types of UML diagrams in the DG. For example, object diagrams.

docs/DeveloperGuide.md

Mick609 · 2021-10-28T03:47:38Z

docs/DeveloperGuide.md

+
+![Main Parser Sequence Diagram](images/MainParserSequenceDiagram.png)
+
+### <a name="command"></a>Command


Sections under “Design” seems not finished. Include “Command”, “ContactList”, and “TextUi”. Please fill them in soon.

For the Command section can consider add in the Class diagram to relate all the commands together

Mick609 · 2021-10-28T03:49:07Z

docs/DeveloperGuide.md


+![Edit Sequence Diagram](images/EditContactCommandSequenceDiagram.png)


This diagram is a bit too big and contains a bit too many details. It would be hard to view this in the FDF format. If all the implementation is necessary for the illustration, the loop in this diagram maybe can be placed in a separate diagram as reference.

I think the constructor for EditContactCommand have not been called ?

ya, I agree with Mick. The diagram seems to be too big which causes the words inside the diagram a bit hard to see. You can try changing the maxMessageLength of this diagram. Also you can consider putting new before a Constructor() call. :)

Mick609 · 2021-10-28T03:50:09Z

docs/DeveloperGuide.md


-## Instructions for manual testing
+## <a name="manual-test"></a>Instructions for manual testing

 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}


Maybe you could provide some instructions here for the manual testing?

jushg

Please try to separate larger diagrams (like the EditContactCommand sequence) out if possible to improve readability

jushg

Can consider to include some more class and object diagrams. Remember to add in the Object Deletion for the Command objects in your sequence diagrams. Overall a very detailed Developer Guide.

docs/DeveloperGuide.md

jushg · 2021-10-28T05:31:18Z

docs/DeveloperGuide.md


+![Edit Sequence Diagram](images/EditContactCommandSequenceDiagram.png)


I think the constructor for EditContactCommand have not been called ?

jushg · 2021-10-28T05:33:05Z

docs/DeveloperGuide.md

+`parseSearchQuery` and the `getDetailFlag` methods respectively. A `SearchContactCommand` with the specified parameters
+will be created and executed in `Duke`. The sequence diagram below shows how the whole process is carried out.
+
+![Search Sequence Diagram](images/SearchContactCommandSequenceDiagram.png)


The SearchContactCommand constructor have also not been called here

jushg · 2021-10-28T05:34:57Z

docs/DeveloperGuide.md

+
+![Main Parser Sequence Diagram](images/MainParserSequenceDiagram.png)
+
+### <a name="command"></a>Command


For the Command section can consider add in the Class diagram to relate all the commands together

jushg · 2021-10-28T05:35:53Z

docs/DeveloperGuide.md

+![Main Parser Sequence Diagram](images/MainParserSequenceDiagram.png)
+
+### <a name="command"></a>Command
+### <a name="contact-list"></a>ContactList


Please remember to update the "Command" and "ContactList" sections soon.

Mick609

The code looks clear and understandable. It would be better if descriptions of methods can be provided.

Mick609 · 2021-10-28T05:07:54Z

src/main/java/seedu/storage/Storage.java

+import java.io.IOException;
+
+public class Storage {
+    private final String contactFilePath;


[marcusbory] Maybe you should use all uppercase for constant.

Mick609 · 2021-10-28T05:16:27Z

src/main/java/seedu/ui/ExceptionTextUi.java

+    }
+
+    //@@author mayankp291
+    public static void missingArgEditMessage() {


[mayankp291] Maybe you could name the method name as a verb. For example, printMissingArgEditMessage in this case. Similar naming issues can be seen in other methods.

Mick609 · 2021-10-28T05:20:41Z

src/main/java/seedu/parser/RegexParser.java

+        //allow lowercase email ids
+        String emailRegex = "^([\\w-\\.]+){1,64}@([\\w&&[^_]]+){2,255}.[a-z]{2,}$";
+        if (!detailToParse.matches(emailRegex)) {
+            //LOGGER.log(Level.INFO, "Regex check for Email id failed");


[mayankp291] If you are not using this line of code for the LOGGER anymore, please delete it.

Mick609 · 2021-10-28T05:22:28Z

src/main/java/seedu/ui/TextUi.java

+    }
+
+    //@@author ashrafjfr
+    public static void helpMessage() {


[ashrafjfr] Maybe you could name this method as an action. For example, printHelpMessage.

Mick609 · 2021-10-28T05:28:59Z

src/main/java/seedu/ui/TextUi.java

+        System.out.println(LINE);
+    }
+
+    public static void welcomeMessage() {


[lezongmun] Maybe you could name the method as an action.

Mick609 · 2021-10-28T05:35:28Z

src/main/java/seedu/parser/DeleteContactParser.java

+    public static final String BUFFER = " ";
+
+    boolean[] hasDeletedDetail(String userInput) throws InvalidFlagException, InvalidDeleteDetailException {
+        boolean[] hasDeletedDetail = new boolean[7]; //all false by default


[ng-andre] I do not really understand the design of the list of boolean variables for hasDeletedDetail. Could you please specify why the length is 7? Maybe avoid the usage of magic numbers.

docs/DeveloperGuide.md

User Guide upgrades

Fix formatting issue

t-l-xin

Need add more details in some parts

docs/DeveloperGuide.md

t-l-xin · 2021-10-29T03:14:23Z

docs/DeveloperGuide.md

+![Sysem Architecture Sequence Diagram](images/SystemArchitectureSequence.png)
+
+
+### <a name="text-ui"></a>TextUi


Text-ui does not seem to be complete, along with Command and ContactList, maybe can try finish up the details soon

docs/DeveloperGuide.md

t-l-xin · 2021-10-29T03:24:05Z

docs/DeveloperGuide.md


+![Edit Sequence Diagram](images/EditContactCommandSequenceDiagram.png)


same issue: diagram too big, can consider representing the circled part to something simpler

One way to solve this is by putting reference frame :D

docs/DeveloperGuide.md

t-l-xin · 2021-10-29T03:34:52Z

docs/DeveloperGuide.md


-## Instructions for manual testing
+## <a name="manual-test"></a>Instructions for manual testing

 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}


Maybe can include some manual testing instructions?

t-l-xin · 2021-10-29T03:39:47Z

docs/DeveloperGuide.md

+`parseSearchQuery` and the `getDetailFlag` methods respectively. A `SearchContactCommand` with the specified parameters
+will be created and executed in `Duke`. The sequence diagram below shows how the whole process is carried out.
+
+![Search Sequence Diagram](images/SearchContactCommandSequenceDiagram.png)


Diagram also quite big, summarise the diagram more, especially the green part

docs/DeveloperGuide.md

Fix <QUERY> issue using escape sequence

Minor code refactor

docs/DeveloperGuide.md

tryyang2001 · 2021-10-29T06:41:21Z

docs/DeveloperGuide.md


+![Edit Sequence Diagram](images/EditContactCommandSequenceDiagram.png)


ya, I agree with Mick. The diagram seems to be too big which causes the words inside the diagram a bit hard to see. You can try changing the maxMessageLength of this diagram. Also you can consider putting new before a Constructor() call. :)

tryyang2001 · 2021-10-29T06:44:35Z

docs/DeveloperGuide.md


+![Edit Sequence Diagram](images/EditContactCommandSequenceDiagram.png)


One way to solve this is by putting reference frame :D

docs/DeveloperGuide.md

# Conflicts: # src/main/java/seedu/command/ViewContactCommand.java

Update DG for formatting error

Add line break to marcusbory.md

PPP updates

Update to UG theme and ashraf PPP

Updated PPP and README

Update UG with new theme

Developer guide updates

Update PPP

Marcus PPP

Update ng-andre PPP

Update PPP

siyuancheng178 reviewed Oct 27, 2021

View reviewed changes

Mick609 reviewed Oct 28, 2021

View reviewed changes

jushg reviewed Oct 28, 2021

View reviewed changes

Mick609 reviewed Oct 28, 2021

View reviewed changes

ShaoYurui reviewed Oct 28, 2021

View reviewed changes

docs/DeveloperGuide.md Show resolved Hide resolved

docs/DeveloperGuide.md Show resolved Hide resolved

marcusbory and others added 7 commits October 29, 2021 01:55

Merge branch 'master' into BugFix-1.0

18fcaa5

Fix syntax + edit personal fields

56f11c0

Merge pull request #125 from marcusbory/BugFix-1.0

8bd5717

User Guide upgrades

Fix formatting issue

a98fae8

Fix <QUERY> issue

e8aa334

Merge pull request #126 from marcusbory/BugFix-1.0

ee3bc07

Fix formatting issue

Fix <QUERY> issue using escape sequence

0f28962

t-l-xin reviewed Oct 29, 2021

View reviewed changes

ng-andre and others added 6 commits October 29, 2021 11:57

Merge pull request #127 from marcusbory/BugFix-1.0

63f2f5d

Fix <QUERY> issue using escape sequence

Add author tags

56652e6

Remove unused imports and constants

17a07c2

Project level code reformat

2289404

Fix checkstyle and some spelling errors in comments

d7240b0

Merge pull request #128 from ng-andre/Refactor-v1.0

26c4392

Minor code refactor

tryyang2001 reviewed Oct 29, 2021

View reviewed changes

ng-andre and others added 9 commits October 31, 2021 13:24

Fix broken link for the list

f07e452

Fix typo for add and delete contact in command summary

d466817

Update FAQ

ef6fb13

Add hyperlink to notations in quick start

094dfca

Update hyperlinks and quick start

58eb2f9

Update to specify extra inputs are ignored

01445d5

Update search flag phrasing

6479e3b

Update email regex

e173806

Merge branch 'master' of https://github.com/AY2122S1-CS2113T-T09-1/tp

dde4267

# Conflicts: # src/main/java/seedu/command/ViewContactCommand.java

ashrafjfr and others added 30 commits November 7, 2021 23:44

Update DG for formatting error

4ee56ce

Merge pull request #196 from ashrafjfr/Developer-Guide-Updates

4d4bea2

Update DG for formatting error

Add line break to marcusbory.md

5ef88e7

Merge pull request #197 from marcusbory/Marcus-PPP

183dc22

Add line break to marcusbory.md

Updated PPP

6ab0938

Merge branch 'master' into DeveloperGuide

118fdd9

Merge pull request #198 from lezongmun/DeveloperGuide

c88b9d4

PPP updates

Updated PPP

1483c6e

Update to UG theme and ashraf PPP

e354ffe

Merge pull request #199 from ashrafjfr/Ashraf-PPP

1fb2935

Update to UG theme and ashraf PPP

Updated README

d2a2846

Merge pull request #200 from lezongmun/DeveloperGuide

63a1a1c

Updated PPP and README

Update UG with new theme

762e5f4

Merge pull request #201 from ashrafjfr/Developer-Guide-Updates

692ffbf

Update UG with new theme

Update to UG and ashraf PPP

08dac1c

Update to UG and DG for pdf conversion

0044343

Update DG for pdf conversion

22feab5

Update Dg for pdf

fe6f2d5

Update PPP

145dfc3

Merge pull request #202 from ashrafjfr/Developer-Guide-Updates

eb1dffa

Developer guide updates

Merge branch 'master' into DeveloperGuide

18c34e4

Merge pull request #203 from lezongmun/DeveloperGuide

e85f9df

Update PPP

Update marcusbory.md

dc4b41f

Update PPP

b106517

Merge pull request #204 from marcusbory/Marcus-PPP

a23a14d

Marcus PPP

Update PPP

f94f319

Merge pull request #205 from ng-andre/Andre-PPP-v2

b83daac

Update ng-andre PPP

Update PPP

09f3fd9

Add author tags

8b45a00

Merge pull request #206 from mayankp291/master

18192ba

Update PPP

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113T-T09-1] ConTech #24

[CS2113T-T09-1] ConTech #24

marcusbory commented Sep 29, 2021

siyuancheng178 Oct 27, 2021

Mick609 left a comment

Mick609 Oct 28, 2021

jushg Oct 28, 2021

Mick609 Oct 28, 2021

jushg Oct 28, 2021

tryyang2001 Oct 29, 2021

Mick609 Oct 28, 2021

jushg left a comment •

edited

Loading

jushg left a comment •

edited

Loading

jushg Oct 28, 2021

jushg Oct 28, 2021

jushg Oct 28, 2021

jushg Oct 28, 2021

Mick609 left a comment

Mick609 Oct 28, 2021

Mick609 Oct 28, 2021

Mick609 Oct 28, 2021

Mick609 Oct 28, 2021

Mick609 Oct 28, 2021

Mick609 Oct 28, 2021

t-l-xin left a comment

t-l-xin Oct 29, 2021

t-l-xin Oct 29, 2021

tryyang2001 Oct 29, 2021

t-l-xin Oct 29, 2021

t-l-xin Oct 29, 2021

tryyang2001 Oct 29, 2021

tryyang2001 Oct 29, 2021


		![Main Parser Sequence Diagram](images/MainParserSequenceDiagram.png)

		### <a name="command"></a>Command


		![Edit Sequence Diagram](images/EditContactCommandSequenceDiagram.png)

		![Sysem Architecture Sequence Diagram](images/SystemArchitectureSequence.png)


		### <a name="text-ui"></a>TextUi

		`Contact`.


		## <a name="implementation"></a>Implementation

[CS2113T-T09-1] ConTech #24

Are you sure you want to change the base?

[CS2113T-T09-1] ConTech #24

Conversation

marcusbory commented Sep 29, 2021

Choose a reason for hiding this comment

Mick609 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jushg left a comment • edited Loading

Choose a reason for hiding this comment

jushg left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mick609 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

t-l-xin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jushg left a comment •

edited

Loading

jushg left a comment •

edited

Loading