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

[danvgar]

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.

[ExperimentsInHonesty]

@danvgar We think this is probably a good idea, can you write the exact change you are suggesting and what text it replaces and where it appears. You can add that in a comment below.

[github-actions]

Hi @danvgar, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[danvgar]

@danvgar We think this is probably a good idea, can you write the exact change you are suggesting and what text it replaces and where it appears. You can add that in a comment below.

Thank you, Bonnie! I'll write something up by the end of this week and move it to the Questions / In Review column and adding the ready for dev lead label once done. 👍

[github-actions]

@danvgar

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, April 2, 2024 at 12:05 AM PST.}