search

hackforla / website

Hack for LA's website
https://www.hackforla.org
GNU General Public License v2.0
324 stars 763 forks source link

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

Open danvgar opened 8 months ago

danvgar commented 8 months ago

Emergent Requirement - Problem

Date discovered

Did you have to do something temporarily

Who was involved

@danvgar

What happens if this is not addressed

Resources

Recommended Action Items

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.

ExperimentsInHonesty commented 6 months ago

@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[bot] commented 6 months ago

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 commented 6 months ago

@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[bot] commented 6 months ago

@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.

danvgar commented 6 months ago

Apologies for the delays, the past two weeks have been a bit hectic in my personal life. I am currently working on these today and tomorrow (Sat Apr 6) and will have an update by EOD Sun Apr 7

danvgar commented 6 months ago

@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.

Hi @ExperimentsInHonesty , see below recommended replacement text for your review.

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.

roslynwythe commented 6 months ago

@ExperimentsInHonesty @danvgar These changes look good to me.

HackforLABot commented 1 month ago

Hi @Thinking-Panda, 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 :)

Thinking-Panda commented 1 month ago

Availability: M-Th 10 AM - 3PM ETA: 9/3/24

Thinking-Panda commented 1 month ago

Understanding the process of making changes to a wiki page. ETA: 9/8/24

Thinking-Panda commented 1 month ago

@roslynwythe @JessicaLucindaCheng How do we make a change to an existing wiki page- How to Review Pull Requests

I read through this resource- (https://github.com/hackforla/website/wiki/How-to-Contribute-to-the-Wiki) and looks like this is for the new website wiki.

Please guide me. Thanks!

ExperimentsInHonesty commented 5 days ago

@Thinking-Panda when you have a question, you need to move your issue to the questions column and add the appropriate ready for label