Skip to content

Improve testing instructions in "How to Review Pull Requests" page #8552

@xnealcarson

Description

@xnealcarson

Overview

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. Without any mention of Docker, onboarded users reviewing their first pull request may have trouble following documentation or properly testing code, resulting in delays.

Action Items

  • In the "How to Review Pull Requests" page, replace the current text:

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.

With this revised version:

Once the branch is installed, run a local copy of the updated site [using Docker](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md#16-dev-setup-6-build-and-serve-the-website-locally), and open [the current live site](https://www.hackforla.org/) 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.

Resources/Instructions

Additional Notes

  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. To make changes to the wiki directly, follow the instructions in this section of GitHub's documentation on Editing wiki pages.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Ready for Prioritization

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions