Skip to content
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

[T12-2] PatientBook #61

Open
wants to merge 706 commits into
base: master
Choose a base branch
from

Conversation

pratyushghosh
Copy link

No description provided.

Copy link

@eugenepeh eugenepeh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a brief look through. Great work so far.

Some things to note though,

  • usually user guide should match the current product, so if its not yet implemented, do mark it with a (future feature) or something. I see that you guys have done that but its not obvious enough :D
  • You can remove the top navigation bar too as it doesn't fit your product nicely.

Keep up the good work towards v1.1

{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
=== Zhang Lizhi
image::kumuwu.png[width="150", align="left"]
{empty}[https://github.com/kumuwu[github]] [<<zhanglizhi#, portfolio>>]

Role: Project Advisor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remember to update the roles too

README.adoc Outdated
https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
https://coveralls.io/github/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
image:https://img.shields.io/vscode-marketplace/r/ritwickdey.LiveServer.svg[Visual Studio Marketplace]
image:https://img.shields.io/beerpay/hashdog/scrapfy-chrome-extension.svg[Beerpay]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these badges relevant to your project?

README.adoc Outdated
ifdef::env-github,env-browser[:relfileprefix: docs/]

https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remember to update the link of original badges too.

. Patient Management Mode: PatientDisplay
. Appointment Management Mode : CalendarDisplay

*User Stories*

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be nice to follow the AB4 style to list it as a table with priorities.

. As a hardworking doctor, I can print out the list of all my patients and hang it on my wall, sothat I am always motivated.
. As a forgetful doctor, I can append any note when I create an appointment, so that when I viewmy appointment I can quickly recall my purpose for the appointment.

*Project Management*

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work on coming up with project management plan, there's also inbuilt GitHub functionality though which you can consider instead of constantly updating the dev guide. e.g. https://github.com/nus-cs2103-AY1819S1/addressbook-level4/projects

* V1.2 Modify EventsCenter API calls, and create modify/create calls to accommodate new logging information for storage I/O.
* V1.3 Format output for BrowserPanel. BrowserPanel will accept a person object (in the case of PatientDisplay) or an appointment object (in the case of Calendar display) and format the output appropriately either through Java or generating and displaying a temporary HTML document.

Feature 4: Natural Language Processing for appointment dates

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can request to use some open source libraries instead.

@damithc
Copy link

damithc commented Oct 2, 2018

Guys, the current version of your team repo is failing CI checks. Try to fix before v1.1

@eugenepeh
Copy link

image

@pratyushghosh @ZZG229 @lixinze777 @shuiherng @kumuwu
Do try to get your travis back up and running soon, its been failing for too long.

Look for ERROR in the travis log and rectify them.

Copy link

@eugenepeh eugenepeh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work, code quality wise seems to be good. Some things, however, need to be updated soon. E.g. Travis.

Other things:

  • Landing page
    • url needs to be updated
      image
  • Gh-pages
    • Update/remove to match your product:
      image
  • README
    • Mock-up looks good
  • User-guide
    • looks good
    • features not implemented yet should be clearly marked as Coming in v2.0
  • Developer guide
    • You can remove Appendix A and G if you want
    • {More to be added} can be removed if no longer applicable
    • Consider adding more NFRs
    • Still a lot of AddressBook references, which should be refactor or removed.

import seedu.address.model.ModelManager;
import seedu.address.model.ReadOnlyAddressBook;
import seedu.address.model.UserPrefs;
import seedu.address.model.*;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remember to disable intellij auto import wildcard
Why is wild card import bad?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, the checkstyle check in travis will fail your CI test if you use import wildcard.

build.gradle Outdated
@@ -66,6 +66,8 @@ dependencies {
implementation group: 'com.sun.xml.bind', name: 'jaxb-impl', version: '2.3.0'
implementation group: 'com.sun.xml.bind', name: 'jaxb-core', version: '2.3.0'
implementation group: 'javax.activation', name: 'activation', version: '1.1.1'
//Import opencsv dependency to access csv file
compile group: 'com.opencsv', name: 'opencsv', version: '4.1'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

compile is actually the syntax of old api, can change to implementation if possible.

@eugenepeh
Copy link

Avoid closing the PR abruptly unless you guys coming up with a new one

@eugenepeh eugenepeh reopened this Oct 22, 2018
@eugenepeh
Copy link

@shuiherng @pratyushghosh @kumuwu @lixinze777 @ZZG229

Feedback for v1.2 T12-2

Please refer to my v1.1 comments for some of the things that you might have missed out.

Landing page

  • As highlighted, the nav bar can be updated as it doesn't applies to your project. Also, badges should be updated accordingly to reflect your repo's status.
    image

Developer Guide

  • Can include some images and diagrams to explain your feature. Also, do try to come up with your design considerations.
    image

  • Diagram not properly cropped. In power point you can actually select the shapes and save as image.
    image

  • Interesting feature, what happen to the conjunction words? Also, can highlight your design considerations and limitations.
    image

  • Abit TLDR because there seems to be more decisions etc under each steps, consider using bullet points to clean up a bit. Also, can use diagrams to project your explanation better.
    image

Overall

  • Do get travis up and running soon.
  • Also, remember to work on making the product user-testable

@eugenepeh
Copy link

Some quick feedback for DG at mid-v1.4:

  • Should point to itself
    image

Also, do check out my previous feedback to ensure that all is taken care of.
Lastly, you guys might want to use diagrams to better explain each of your features

kumuwu and others added 30 commits November 12, 2018 22:09
remove unnecessary stuff in AboutUs
Project Portfolio Added & Licenses Added to README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
8 participants