-
Notifications
You must be signed in to change notification settings - Fork 262
[CS2103T-F10-3] NOVA #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
[CS2103T-F10-3] NOVA #45
Conversation
* update AboutUs * update AboutUs * update ContactUs * update readme * Fix checkstyle violations Co-authored-by: Nicholas Cristian Fernando <[email protected]>
heidicrq
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job in general.
docs/DeveloperGuide.adoc
Outdated
| |`* *` |student |add contact information on CS2103T professors |can contact them | ||
|
|
||
| |`* * *` |student |create meeting events | can keep track of my schedule | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
User stories are not sorted by priority.
| |`* * *` |student |create study session events | can keep track of my schedule | ||
|
|
||
| |`* * *` |student |create consultation events | can keep track of my schedule | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same benefit. Can add more details or be more specific about the benefits.
docs/DeveloperGuide.adoc
Outdated
| . The application should respond to every command within one second. | ||
| . Technical requirements: The application should work on both 32-bit and 64-bit environments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not app specific.
zixinn
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job!
docs/DeveloperGuide.adoc
Outdated
|
|
||
| |`* * *` |student |delete classmate or teammate’s contact |delete if not necessary anymore | ||
|
|
||
| |`* * *` |student |categorise contacts into teammate or classmate | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing benefit for user story
| _{More to be added}_ | ||
|
|
||
| [appendix] | ||
| == Non Functional Requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NFR not app-specific
| _{More to be added}_ | ||
|
|
||
| [appendix] | ||
| == Glossary |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Important terms missing, e.g. CLI, GUI
alushingg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job
docs/DeveloperGuide.adoc
Outdated
|
|
||
| |`* * *` |student |edit profile picture to added contact |edit the picture if changes are necessary | ||
|
|
||
| |`* * *` |student |delete profile picture to added contact| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing benefit
| _{More to be added}_ | ||
|
|
||
| [appendix] | ||
| == Glossary |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe can add a glossary for MSS, Extensions
NNpanpan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job, guys!
docs/DeveloperGuide.adoc
Outdated
|
|
||
| |`* * *` |student |delete profile picture to added contact| | ||
|
|
||
| |`* * *` |student |add category specific description |filter out a contact’s remark according to type of contact |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Category specific" - Should clarify which objects' categories that are mentioned
|
|
||
| |`* * *` |student |create lesson events | can keep track of my schedule | ||
|
|
||
| |`* * *` |student |note down the location of the meeting | know where to go |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does "note down" mean in this system?
docs/DeveloperGuide.adoc
Outdated
| . Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. | ||
| . 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. | ||
| . The application should respond to every command within one second. | ||
| . Technical requirements: The application should work on both 32-bit and 64-bit environments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that almost all personal computers are running 64-bit OSes, is this a necessary constraint?
| |`* * *` |student |create meeting events | can keep track of my schedule | ||
|
|
||
| |`* * *` |student |create study session events | can keep track of my schedule | ||
|
|
||
| |`* * *` |student |create consultation events | can keep track of my schedule | ||
|
|
||
| |`* * *` |student |create lesson events | can keep track of my schedule |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would better if the "so that I..." part is more descriptive and detailed. This can help us to show that the user stories/features provided are very useful and specific for the target user.
docs/DeveloperGuide.adoc
Outdated
|
|
||
| |`* * *` |student |find events | can check if I have any specific events according to keyword(s) | ||
|
|
||
| |`* *` |student |add notes to events | can jot down additional details about the events |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be useful to elaborate "jot down additional details" so as it's clearer as a benefit.
dinhnhobao
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done!
1ad4b58 to
e7d3dbe
Compare
docs/DeveloperGuide.adoc
Outdated
| . In addition, the `CommandResult` object can also instruct the `Ui` to perform certain actions, such as displaying help to the user. | ||
|
|
||
| Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("delete 1")` API call. | ||
| Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("done t\2020-03-20 i\2")` API call. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sequence diagram looks too complicated. Perhaps you could abstract out some of the information and create another separate sequence diagram such that each diagram contains lesser and more relevant information.
docs/DeveloperGuide.adoc
Outdated
|
|
||
| 5. `Model#markDone()` is called, and the `Schedule` object in `ModelManager` is updated. | ||
|
|
||
| The following sequence diagram shows how the mark event as done operation works: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This diagram is repetitive and does not provide additional information.
docs/DeveloperGuide.adoc
Outdated
|
|
||
| *API* : | ||
| link:{repoURL}/src/main/java/seedu/address/logic/Logic.java[`Logic.java`] | ||
| link:{repoURL}/src/main/java/seedu/nova/logic/Logic.java[`Logic.java`] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The same diagram is duplicated above, in the higher-level description of the app's architecture. Perhaps a simpler and more abstract diagram could be used to describe the higher-level summary of Logic (and you can leave the more detailed diagram of Logic here)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but I think its good that you provided some notes for the XYZCommand (in the class diagram)
| @@ -1,8 +1,9 @@ | |||
| = AddressBook Level 3 - Developer Guide | |||
| = NOVA - Developer Guide | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The uml diagrams are not consistent - one is just white boxes but the other is white box highlighted with red lines. Maybe can make them all just non-highlight or make them all highlighted with different colours
| === Model component | ||
|
|
||
| .Structure of the Model Component | ||
| image::ModelClassDiagram.png[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the empty box between person and email and category?
… into branch-PPP # Conflicts: # docs/team/huixianc.adoc
Replaced Ui.png with Windows version
Updated links for PRs
DG: Fixed broken link in DG for Main.java and MainApp.java, Updated Ui.png Windows ver (with black border)
Fixed spaces in error message
* 'master' of https://github.com/AY1920S2-CS2103T-F10-3/main: updated dg updated dg Fixed progress calculation. fixed spaces in error message fixed spaces in error message
Update UserGuide.adoc
Edited Ui.png again, UG change: Changed team name (removed "Team" in front)
edited error messages
Edited UG: Command Summary to include Bryan's name
# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
Edited error message
Change to 1.4.0 in MainApp.java
@huixianc @lohszeying @mightyrabbit99 @xCelestialPhoenix @BryanYap972