jhu-oose-f22 / team-gobluejays

team-gobluejays created by GitHub Classroom
2 stars 0 forks source link

Feedback on iteration 1 #32

Open darvishdarab opened 2 years ago

darvishdarab commented 2 years ago

Iteration 1 (90 Points)

Software Requirement Specification (28 points)

    - Problem Statement (5/5 points)
        Very good
    - Proposed Solution (5/5 points)
        Very good
    - Potential Clients (4/4 points)
    - Must Haves (5/5 points)
        You have a long list of must-haves, please keep in mind that you have to deliver all of the must-haves, so make sure you have enough time and bandwidth to deliver them all. If you are not 100% confident, you can move some of them to nice-to-have section, but also remember that your app must go beyond CRUD so if you end up relocating some of the user stories, make sure you still have enough beyond CRUD features under must-haves.
    - Nice to Haves (4/5 points)
        Since you have a decent number of nice-t-haves too, you might need to prioritize the ones that have a higher priority for you to implement first
    - Architecture (4/4 points)
        Good

Class Diagram (9/10 points)

- Must use correct UML notation (5/5 points)
- The class diagram is in-sync with stated user stories listed and system requirements listed in SRS. (4/5 points)
  Is there a reason that a Schedule class is not needed? 
  You have an add event feature, but event is not a class that extends from EventTemplate. From the input parameters, it doesn't seem like an event is a Course or Reminder.

Git Activities (10/10 points)

Good

Github Project (15/15 points)

The project is nicely documented. Keep it up! Though, you have too many folders at the top level of your repo. What are all these folders for? Please organize your repo structure (e.g. move all source folders under a `src` folder, get rid of editor/build folders by adding them to your .gitignore etc.)

Implementation (15/22 points)

I don't think the add event function is fully functional the way it is right now. The calendrer is not interactable and the week is fixed to the week of Sep 12. In addition, even though on the add event page the user is asked to enter a date, the format is actually the three letter code for each day of the week. It would be helpful beside each entry to tell the user what format you are expecting. When an event is added, it is like a fixed block pasted onto a picture of a calendrer. Your current implementation of adding an event will not be helpful for future implementations that depend on adding events. Currently, there is also no way for the user to exit the add event page if they accidentally clicked on it. They are forced to add an event to return to the calendrer page. Finally, it might be a good idea to add some error handling. For example, if the user forgot to enter a date or time, instead of the app directly crashing, you can handle the error and send a message to the user.

README (5/5 points)

- README included:
    - provides info about the app
    - provides info how to run the app
    - etc. 
Good job on keeping different sections of README updates. Please continue to do so for future iterations. There is a typo in your Installation command, instead of pods install, it is pod install.

Comments

Total: 81/90

Advisor Name: Shanelle

darvishdarab commented 2 years ago

Iteration 1 (90 Points )

Software Requirement Specification (27/28 points)

- All sections should be complete
    - Problem Statement (5/5 points)
        Very good
    - Proposed Solution (5/5 points)
        Very good
    - Potential Clients (4/4 points)
    - Must Haves (5/5 points)
        You have a long list of must-haves, please keep in mind that you have to deliver all of the must-haves, so make sure you have enough time and bandwidth to deliver them all. If you are not 100% confident, you can move some of them to nice-to-have section, but also remember that your app must go beyond CRUD so if you end up relocating some of the user stories, make sure you still have enough beyond CRUD features under must-haves.
    - Nice to Haves (4/5 points)
        Since you have a decent number of nice-t-haves too, you might need to prioritize the ones that have a higher priority for you to implement first
    - Architecture (4/4 points)
        Good

Class Diagram (10/10 points)

- Must use correct UML notation (5/5 points)
- The class diagram is in-sync with stated user stories listed and system requirements listed in SRS. (5/5 points)
  Good

Git Activities (10/10 points)

Good

Github Project (15/15 points - Deadline was 10/5 4pm)

The project is nicely documented. Keep it up!

Implementation (17/22 points - Deadline was 10/5 4pm)

- Nice implementation of home page.
- The calendar is not interactable and the week is fixed to the week of Sep 12. Events can only be added for the week of Sep 12.
- In addition, even though on the add event page the user is asked to enter a date, the format is actually the three letter code for each day of the week. It would be helpful beside each entry to tell the user what format you are expecting. 
- Currently, there is also no way for the user to exit the add event page if they accidentally clicked on it. They are forced to add an event to return to the calendar page.
- Finally, it might be a good idea to add some error handling. For example, if the user forgot to enter a date or time, instead of the app directly crashing, you can handle the error and send a message to the user.

README (5/5 points)

- There is a typo in your Installation command, instead of pods install, it is pod install.

Comments

See each section above.

Things Done Well

Things That Can Be Improved

Other Comments

Total: 84/90

Advisor Name: Shanelle