Skip to content
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

Docs: polish README.md #656

Merged
merged 5 commits into from
Apr 16, 2024
Merged

Conversation

dpprdan
Copy link
Contributor

@dpprdan dpprdan commented Jul 12, 2023

These changes make the README a bit more comprehensible (IMHO) and fixes a few typos.

I propose to discuss the changes for this single README first and then roll the changes out to the others as well (either with this or another PR).

cf #653

These changes (hopefully) make the README a bit more comprehensible.
@dpprdan dpprdan requested a review from a team as a code owner July 12, 2023 12:27
src/python/README.md Outdated Show resolved Hide resolved
@dpprdan
Copy link
Contributor Author

dpprdan commented Jul 12, 2023

This sentence is still a bit too terse IMHO:

You can decide how often you want updates by referencing a semantic version of each image.

Which updates are meant here?

Copy link
Member

@samruddhikhandale samruddhikhandale left a comment

Choose a reason for hiding this comment

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

Thank you for taking the time to polish the README, we appreciate it ✨

Left one comment, besides that looks good to me!

src/python/README.md Outdated Show resolved Hide resolved
bamurtaugh
bamurtaugh previously approved these changes Jul 12, 2023
Copy link
Member

@bamurtaugh bamurtaugh left a comment

Choose a reason for hiding this comment

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

Thanks so much for taking the time to put this together, @dpprdan!

Copy link
Member

@bamurtaugh bamurtaugh left a comment

Choose a reason for hiding this comment

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

Thanks so much for taking the time to put this together, @dpprdan! (updating to "comment" rather than "approve" as that's the feedback level I meant initially, as we're still actively discussing a few things😄)

@bamurtaugh bamurtaugh self-requested a review July 12, 2023 17:09
Co-authored-by: Brigit Murtaugh <[email protected]>
nmamlm referenced this pull request Jul 21, 2023
@dpprdan
Copy link
Contributor Author

dpprdan commented Apr 14, 2024

@bamurtaugh How would like to proceed here? Can this PR be merged?

bamurtaugh
bamurtaugh previously approved these changes Apr 15, 2024
Copy link
Member

@bamurtaugh bamurtaugh 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 your contribution and collaboration!

@bamurtaugh
Copy link
Member

@samruddhikhandale are you okay with approving the workflow run here? Since that's more your area of expertise, I'll hold off.

Copy link
Member

@samruddhikhandale samruddhikhandale left a comment

Choose a reason for hiding this comment

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

Apologies for a late review, looks like this PR slipped through the gaps.

Thanks @bamurtaugh for looping me in. Overall the PR looks great, left one minor comment.

src/python/README.md Outdated Show resolved Hide resolved
Co-authored-by: Samruddhi Khandale <[email protected]>
@samruddhikhandale samruddhikhandale merged commit 4e4b4c4 into devcontainers:main Apr 16, 2024
1 check passed
@dpprdan dpprdan deleted the patch-1 branch April 17, 2024 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants