InfinityTwo / pe

0 stars 0 forks source link

Developer Guide: Incomplete Guide, Missing Items #4

Open InfinityTwo opened 4 days ago

InfinityTwo commented 4 days ago

Issue The guide seems to be incomplete overall. There are a few missing items and a few incomplete items.

Expected Result The Developer Guide to be completed with relevant data.

Actual Result

Missing Diagram (Here's a diagram but nothing is there)

image.png

Placeholder Text

image.png

nus-pe-bot commented 16 hours ago

Team's Response

Duplicate.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

No uml diagrams in DG

Description No uml diagrams at all in DG, even though diagrams are being mentioned in DG.

Steps to reproduce View DG.

Expected Found uml diagrams for developers.

Actual No uml diagrams found, even when they are being mentioned in DG.

Screenshots

image.png

image.png


[original: nus-cs2103-AY2425S1/pe-interim#1435] [original labels: type.DocumentationBug severity.High]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Changed to severity.Medium since the application and the DG is still usable.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.Medium`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** The diagrams are critical for Developers to understand the **major** core features and workflow of the application code. Without **ALL** diagrams (if this was one or two, I agree for Medium severity), it makes a large section of the DG unusable and makes it extremely hard to maintain the code for all new developers.