Skip to content

Updates CONTRIBUTING.md section 1.5.a by Adding New Information #8038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from

Conversation

jsnhn
Copy link
Member

@jsnhn jsnhn commented Apr 3, 2025

Fixes #7642

What changes did you make?

  • Adds new information at the end of section 1.5.a Docker installation troubleshooting in CONTRIBUTING.md

Why did you make the changes (we will use this info to test)?

CodeQL Alerts

After the PR has been submitted and the resulting GitHub actions/checks have been completed, developers should check the PR for CodeQL alert annotations.

Check the PR's comments. If present on your PR, the CodeQL alert looks similar as shown

Screenshot 2024-10-28 154514

Please let us know that you have checked for CodeQL alerts. Please do not dismiss alerts.

  • I have checked this PR for CodeQL alerts and none were found.
  • I found CodeQL alert(s), and (select one):
    • I have resolved the CodeQL alert(s) as noted
    • I believe the CodeQL alert(s) is a false positive (Merge Team will evaluate)
    • I have followed the Instructions below, but I am still stuck (Merge Team will evaluate)
Instructions for resolving CodeQL alerts

If CodeQL alert/annotations appear, refer to How to Resolve CodeQL alerts.

In general, CodeQL alerts should be resolved prior to PR reviews and merging

Screenshots of Proposed Changes To The Website (if any, please do not include screenshots of code changes)

Visuals before changes are applied

Screenshot 2025-04-02 at 7 50 35 PM

Visuals after changes are applied

Screenshot 2025-04-02 at 7 51 05 PM

Copy link

github-actions bot commented Apr 3, 2025

Want to review this pull request? Take a look at this documentation for a step by step guide!


Note that CONTRIBUTING.md cannot previewed locally; rather it should be previewed at this URL:

https://github.com/jsnhn/website/blob/adds-info-section-1.5.a-7642/CONTRIBUTING.md  

@github-actions github-actions bot added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Feature: Wiki Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 0.5pt Can be done in 3 hours or less labels Apr 3, 2025
@DDVVPP DDVVPP self-assigned this Apr 3, 2025
@DDVVPP
Copy link
Member

DDVVPP commented Apr 3, 2025

Review ETA: 6 PM PDT Saturday, March 5, 2025
Availability: 11 AM - 5 PM PDT M - F

Copy link
Member

@DDVVPP DDVVPP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jsnhn great work!

I just wanted to add a minor suggestion for improvement in your Why did you make the changes (we will use this info to test)? section:

  • As the ticket indicates, I would replace the two bullet points after the first one, just with: For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]
  • Place the URL that is currently in your For example:... bullet point, where it says [REPLACE WITH TEST URL]

Other than that,

  • The PR title and branch name are clear
  • Preview URL shows updated section 1.5a with correct changes
  • Action items in issue were checked off
  • The before and after visuals look good

@github-project-automation github-project-automation bot moved this from PR Needs review to PRs being reviewed in P: HfLA Website: Project Board Apr 4, 2025
@daras-cu daras-cu requested review from dvernon5 and trca831 April 9, 2025 02:35
@dvernon5
Copy link
Member

dvernon5 commented Apr 9, 2025

ETA: EOD
Availability: Monday-Thursday 12PM - 6PM and Friday 12PM - 4PM

Copy link
Member

@dvernon5 dvernon5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @jsnhn

Great work on your PR! You've completed all tasks, linked the PR to the correct branch, and the PR title is well crafted.

As @DDVVPP stated:

  • "replace the two bullet points after the first one, just with: For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]"
  • "Place the URL that is currently in your For example:... bullet point, where it says [REPLACE WITH TEST URL]"

Once those changes are made re-request my review, and I'll approve it from there.

Once again awesome job!

@trca831
Copy link
Member

trca831 commented Apr 14, 2025

Review ETA: 10 PM PST Monday, April 14th, 2025
Availability: 11 AM - 3 PM PST Fri-Sat

Copy link
Member

@trca831 trca831 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @jsnhn — nice work on the PR!

You've checked all the boxes: tasks are done, the branch is correct, and the title looks solid.

Just echoing what @DDVVPP mentioned — for the reviewer notes:

Swap out the two bullet points after the first one with:
"For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]"

Then, move the current URL from your "For example:..." bullet point into that [REPLACE WITH TEST URL] spot.

Once you’ve made those tweaks, just re-request a review and I’ll get it approved.

Really great job overall!

@t-will-gillis t-will-gillis self-requested a review April 20, 2025 18:02
Copy link
Member

@t-will-gillis t-will-gillis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jsnhn - These are some comments in addition to the previous reviewers' comments:

  • Please remove the inserted lines (currently 232 and 233) <!-- Added information below --> and the extra newline.
  • Unfortunately, although you correctly copied the text for insertion as instructed by the original issue, the original issue contains formatting errors that need to be fixed. Please replace the original text with:
     If you are using Windows Subsystem for Linux (WSL) and finding a permission error when running `docker-compose up`, the issue might be caused by a version of Docker that relies on a buggy version of Go. In your terminal, run `docker version` to see which `Go version:` is listed. Any version less than `go1.20.0` has a problem and indicates that your Docker needs to be updated.
    

Apologies for our last minute text edits, but the text we provided you has errors and needs to be changed before we can merge it. (I made this change to the original issue also.) Please make the changes above in addition to the previous reviewers' requested changes, and when complete select the chasing arrows next to each reviewers name to Re-request review.

Thank you!

Copy link
Member

@DDVVPP DDVVPP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making the changes @jsnhn !

  • The bullet point in the Why did you make the changes... section has been updated with the correct link
  • The text updates later requested by @t-will-gillis have been made

One small additional update!

  • Looks like the image in Visuals after changes are applied don't yet reflect the final text changes you've made - It would just be nice to see this update as well for consistency!

Thanks so much!

Copy link
Member

@dvernon5 dvernon5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jsnhn

Thank you for implementing the changes!

  • You successfully addressed the updated requirements from @t-will-gillis
  • Your test link is works correctly and reflects the updated content.

Great catch by @DDVVPP on the details! As she noted, while it's a minor update, the Visuals after changes are applied section should include the final updated image for consistency. Currently, the image and CONTRIBUTING.md file don't align, which could cause confusion.

You're nearly there! Everything else looks excellent, just one more change to update the final image to match.

Thank you for your hard work. Please re-request my review once the change is made.

@melissaluc melissaluc requested review from melissaluc and removed request for melissaluc April 25, 2025 18:22
@t-will-gillis
Copy link
Member

Hi @jsnhn Your PR is nearly complete- to finish, please either swap out an updated screenshot of the CONTRIBUTING.md section, OR you could also remove both screenshots and replace with No visual changes to the website (since you are providing a link for reviewers).

Thanks!

@t-will-gillis
Copy link
Member

@jsnhn Checking in one last time. Please see the notes above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Wiki role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Projects
Status: PRs being reviewed
Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md Section 1.5.a
5 participants