-
-
Notifications
You must be signed in to change notification settings - Fork 830
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
base: gh-pages
Are you sure you want to change the base?
Conversation
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:
|
Review ETA: 6 PM PDT Saturday, March 5, 2025 |
There was a problem hiding this 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
ETA: EOD |
There was a problem hiding this 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!
Review ETA: 10 PM PST Monday, April 14th, 2025 |
There was a problem hiding this 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!
There was a problem hiding this 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!
There was a problem hiding this 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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Hi @jsnhn Your PR is nearly complete- to finish, please either swap out an updated screenshot of the Thanks! |
@jsnhn Checking in one last time. Please see the notes above. |
Fixes #7642
What changes did you make?
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
Please let us know that you have checked for CodeQL alerts. Please do not dismiss alerts.
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
Visuals after changes are applied