ER: Improve testing instructions to "How to Review Pull Requests" page #6319

Emergent Requirement - Problem

• In How to Review Pull Requests documentation, the Step 3: View the changes in the browser section mentions opening up the branch in your browser's localhost:4000 but does not mention Docker or link to the Docker instructions in the contributing guide.

Date discovered

• Feb 18, 2024

Did you have to do something temporarily

• YES
• NO

Who was involved

@danvgar

What happens if this is not addressed

• Onboarded users reviewing their first pull request may have trouble following documentation or properly testing code, resulting in delays.

Resources

• How to Review Pull Requests
• How to Review Pull Requests - Step 3: View the changes in the browser
• CONTRIBUTING.md - 1.6 Dev setup (6): Build and serve the website locally

Recommended Action Items

• Make a new issue using the draft revision below

Proposed Solutions

Current Text at How to Review Pull Requests

Once the branch is installed, run the website and view it in the browser. You will also want to open our website in a new tab. Locate the collaborator's changes on both sites and consider whether these changes address the issue. Some important questions to ask are:

1. Are the changes applicable to the issue?
2. Are there changes beyond those applicable to the issue?
3. Does the website appear less user-friendly?
4. Do the links and components on the page still work as intended?

In addition to viewing changes on your desktop browser, you must also assess these changes in multiple viewports (such as mobile or tablet), through your browser's developer mode.

Proposed Replacement at How to Review Pull Requests

Once the branch is installed, run a local copy of the updated site using Docker, and open the current live site in a new tab. Locate the collaborator's changes on both sites and consider whether these changes address the issue. Some important questions to ask are:

1. Are the changes applicable to the issue?
2. Are there changes beyond those applicable to the issue?
3. Does the website appear less user-friendly?
4. Do the links and components on the page still work as intended?

In addition to viewing changes on your desktop browser, you must also assess these changes in multiple viewports (such as mobile or tablet), through your browser's developer mode.

Note

1. Since we want to make sure any edits to existing wiki pages end up in the new website-wiki, please follow the instructions in https://github.com/hackforla/website/wiki/How-to-Contribute-to-the-Wiki

2. We haven't really been editing the existing wiki pages in this repo's (hackforla/website) wiki. However, if you do want to edit an existing page, you can edit it directly by following the instructions in this section of GitHub's documentation on Editing wiki pages.