search

Chen-Yiyang / pe

0 stars 0 forks source link

Incorrect Link for `MainApp.java` in DevOps Guide #6

Open Chen-Yiyang opened 3 years ago

Chen-Yiyang commented 3 years ago

The link for the MainApp.java in the team's DevOps Guide points to the java file in the original addressbook-level3's GitHub repo, not that of the team repo.

Steps to reproduce:

  1. Go to https://ay2122s1-cs2103t-t11-1.github.io/tp/DevOps.html#repository-wide-checks for the team's DevOps Guide.
  2. Find the section "Making a release"
  3. Click on the link in the MainApp.java in the section.
nus-pe-bot commented 3 years ago

Team's Response

Thank you for reporting this issue.

It is valid but this issue is rejected as the PE instructions state that only the content inside the UG DG PDF files should be considered for documentation bugs. This issue is found on the DevOps guide on the online version which is out of the scope of this PE.

image.png

The 'Original' Bug

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

[DG] MainApp.java link in DevOps guide is not updated

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

In DevOps guide, MainApp.java link is pointing to AB-3's MainApp.java and not the team's one.

Screenshot 2021-11-12 at 5.35.32 PM.png

[original: nus-cs2103-AY2122S1/pe-interim#4817] [original labels: severity.VeryLow type.DocumentationBug]

Their Response to the 'Original' Bug

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

Thank you for reporting this issue.

It is valid but this issue is rejected as the PE instructions state that only the content inside the UG DG PDF files should be considered for documentation bugs. This issue is found on the DevOps guide on the online version which is out of the scope of this PE.

image.png

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 response

Team chose [response.Rejected]

Reason for disagreement: Since the link is in your UG/DG file being evaluated. You need to make sure it directs the user to the correct destination.

If you think this is something to be neglected, why do you put the link in your DG?

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: This is not cosmetic issue. It confuses the user, especially if the user wants to contribute to your codebase in the future.

Therefore, severity should not be severity.VeryLow but severity.Low.