docs: adds in information on how to test PRs in GitHub Codespaces #2617
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shkeating
added
type: documentation
shkeating
changed the title
werdnanoslen
reviewed
Oct 4, 2023
Co-authored-by: Andrew Nelson <andy@andyhub.com>
werdnanoslen
previously approved these changes
Oct 4, 2023
kimallen
reviewed
Oct 4, 2023
kimallen
reviewed
Oct 4, 2023
kimallen
reviewed
Oct 4, 2023
… message or it goes away before you click it.
|
@werdnanoslen @kimallen thank you both for your feedback! I added more info and made changes to reflect your suggestions :) |
kimallen
reviewed
Oct 6, 2023
kimallen
previously approved these changes
Oct 6, 2023
Co-authored-by: Kim Allen <kim@truss.works>
brandonlenz
requested changes
Oct 12, 2023
|  | ||
|
|
||
| 11. proceed as if you were running the PR on your own machine. hooray! | ||
| 12. When your review is complete, you should delete the codespace. There are costs associated with storing codespaces. **You should therefore delete any codespaces you no longer need**. |
There was a problem hiding this comment.
Bummer that this isn't free for open source repositories, but I understand why. Looks like costs are pretty minimal, and free for the first (up-to) 60 hours per month.
This is definitely something we should still be vigilant about. It's easy to "leave the stove running" on this switching contexts to and from ReactUSWDS
There was a problem hiding this comment.
Nothing to change on the PR, the step is explicit, just a thought I had while reading and learning about Codespaces (I haven't used them before!)
Co-authored-by: Brandon Lenz <15805554+brandonlenz@users.noreply.github.com>
Co-authored-by: Brandon Lenz <15805554+brandonlenz@users.noreply.github.com>
Co-authored-by: Brandon Lenz <15805554+brandonlenz@users.noreply.github.com>
Co-authored-by: Brandon Lenz <15805554+brandonlenz@users.noreply.github.com>
brandonlenz
approved these changes
Oct 12, 2023
|
Hello! Here is some feedback on the documentation as promised. I could only find 1 thing that might need some clarity. I am learning your superpower is documentation.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds info doc about using Codespaces to review PRs so you can check out changes and run them on a dev server without having to on your machine, reducing context switching and lowering the barrier to PR reviews.
Adds reference in design PR review doc to this page
Related Issues or PRs
docs: add design PR review documentation #2615
How To Test
Int he changed files view, click the icon in the upper right of the md file for
Display rich diff. This will let you preview the markdown file. Follow the steps in the process and make sure I have outlined the process well enough for you to figure it out.