-
Notifications
You must be signed in to change notification settings - Fork 69
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
[v1.0][W15-B1] E.T. (Employees Tracker) #43
base: master
Are you sure you want to change the base?
Conversation
IzHoBX
commented
Mar 7, 2018
- Add user stories
- Add use cases
- Add NFRs
- Add lock and unlock command
- Add rate command
- Add sort command
- Add find by any field
Hi @IzHoBX, your pull request title is invalid. For phase A, it should be in the format of For phase B, it should be in the format of Please follow the instructions given strictly and edit your title for reprocessing. Submit only one learning outcome per pull request (unless otherwise stated in instructions) and do remember to create your branches from the commit where the Note: this comment is posted by a bot. If you believe this is done in error, please create an issue at cs2103-pr-bot and add a link to this PR. |
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 coverage of user-stories, use cases, and NFRs. Please address some minor comments mentioned in this review.
A glance at your organization repo showed that some individual PRs were merged despite Travis build failure (e.g., Sort command, Rate command, etc.). Normally it is a good idea to merge only passed builds into the master branch. This will help you in isolating broken commits. Coding standard violation is one of the main issues of Travis build failure and thus sticking to the standards provided is of utmost importance.
Also, it is nice to see that issue-tracker has been set up.
Do not close this PR, as we'll be using this PR for your subsequent milestones!
README.adoc
Outdated
@@ -1,7 +1,7 @@ | |||
= Address Book (Level 4) |
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.
I guess your project is not Address Book anymore :p, please update the Address Book mentions from all instances. You might also need to update or remove stuff that relates only to address-book and not to your project.
docs/DeveloperGuide.adoc
Outdated
@@ -10,7 +10,8 @@ ifdef::env-github[] | |||
:tip-caption: :bulb: | |||
:note-caption: :information_source: | |||
endif::[] | |||
:repoURL: https://github.com/se-edu/addressbook-level4/tree/master | |||
:repoURL: https://github.com/CS2103JAN2018-W15-B1/main/tree/master | |||
|
|||
|
|||
By: `Team SE-EDU` Since: `Jun 2016` Licence: `MIT` |
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.
Team name should be different.
docs/DeveloperGuide.adoc
Outdated
|
||
|`* * *`|user |add a new person | include employees that have just entered the company | ||
|
||
|`* * *`|user |each employee has his/her dedicated timetable | trace progress of that person |
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 particular user story doesn't adhere to the "I want to..." prefix. When read together, the whole story should be grammatically coherent.
docs/DeveloperGuide.adoc
Outdated
|
||
|`* * *`|user |add notes on a timetable entry or on a person | include more details about the entry | ||
|
||
|`* * *`|user |search employees by specific criteria | search employees more easily |
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.
Might be a good idea to enlist a couple of criteria's possible. That way reader can understand which criteria you are planning to consider.
docs/DeveloperGuide.adoc
Outdated
|
||
|`*`|user |unlock the addressbook |continue to use the app after leaving it locked | ||
|
||
|`*`|user |write a review to an employee that has ever worked below me| information his/her current manager of his/her performance | ||
|======================================================================= | ||
|
||
_{More to be added}_ |
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 comment can be removed if no more stories are planned to be added.
docs/DeveloperGuide.adoc
Outdated
3. User requests to delete a specific person in the list | ||
4. AddressBook deletes the person | ||
1. User requests to list employees | ||
2. AddressBook shows a list of employees |
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.
Its probably best to rename "AddressBook" as this new app is not exactly an "Address Book".
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. | ||
. Should be able to hold up to 1000 persons without a noticeable sluggishness (i.e. response time >500ms) in performance for typical usage. | ||
. A user with above average typing speed (i.e. >=45 words per minute) 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. |
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 to see changes made as per discussion in the tutorial.
Enhance help/man command
Use CalendarFX to display Calendar View
Overall User Guide has been updated and reflects the plan. In Developer Guide, I could not find sequence diagrams in the implementations. Generally, its good to add visual cues to aid the reader. In the User Guide its good to see the plan for different features correlating to different version releases. |
Make undo
Update collate
Incremental Update before v1.5rc
Documentation and Collate
Update AbooutUs
UserGuide: Update image
Re-collate
AboutUs.adoc and PPP
Fix capitalization
Update Class Diagram
Final documentation update
update ppp html version