search

Jaspertzx / pe

0 stars 0 forks source link

The DevelopGuide mentions that the Model object is still called Person #10

Open Jaspertzx opened 2 months ago

Jaspertzx commented 2 months ago

InternHub is about managing applications, yet the Developer Guide (DG) still references the person class throughout the application.

This should be properly named as CS2103 recommends the naming of models to be related to what they are representing.

In fact, the User Guide has mentioned that what the user is adding is an internship application (as shown below). The InternHub DG and java files should have been refactored to update with this new context change.

image.png

Rationale for a medium: I have given this a medium, as it makes it very difficult for incoming developers to continue working on this project with this mislabbeled model. It continued work on the project confusing for developers and the code base is hard to maintain as we have to constantly remind ourselves that internship applications is the equivalence of a person class.

A few of the many examples:

image.png

image.png

nus-se-bot commented 2 months ago

Team's Response

Dear tester,

We want to thank you for your feedback.

At the moment, we are not changing the Person class to "Internships", which is why our diagrams are all named Person. We are following the addressbook convention for all our uml diagrams and code base. Our documentation mirrors our code, so there is no error there.

In the future, we aim to adjust the naming of the code to better suit our product.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]