-
Notifications
You must be signed in to change notification settings - Fork 650
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
Update README.md #3630
Update README.md #3630
Conversation
I reviewed the README text, applying some layout improvements and minor copy edits. I also added a new section, "Contributing guidelines", please provide feedback on that! Signed-off-by: Giulia Zanchi <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3630 +/- ##
=======================================
Coverage 88.88% 88.88%
=======================================
Files 254 254
Lines 14225 14225
=======================================
Hits 12644 12644
Misses 1581 1581 ☔ View full report in Codecov by Sentry. |
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.
Overall, it looks like a good improvement to me. The only other improvement I see that needs to be made is to update the relevant info with the current lts.
I've applied all the fixes suggested by the team (thanks Andrei, Jia and Scott!). Please review and see if it's all good now. I have also been testing the instructions to Multipass, they need some debugging. For now I'll leave the contributing info as a subsection of the Readme, but let's consider the possibility of having it as a separate file as it's done on other projects. Signed-off-by: Giulia Zanchi <[email protected]>
@andrei-toterman @georgeliao @sharder996 please review the latest fixes and approve if it looks good now! I'll keep working on the "build Multipass" instructions and create a separate PR if needed. |
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.
Looks good to me.
README.md
Outdated
Description: Ubuntu 18.04.1 LTS | ||
Release: 18.04 | ||
Codename: bionic | ||
Distributor ID: Ubuntu |
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.
can we make the 2nd column left aligned like the text before?
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.
OK I checked the alignment, please see if it looks correct now.
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.
Now, it looks good.
Removed secondary IP address from "dancing-chipmunk" in the first example output of `multipass list`. Signed-off-by: Giulia Zanchi <[email protected]>
Removed secondary IP from "dancing-chipmunk" in the output of `multipass info`. Signed-off-by: Giulia Zanchi <[email protected]>
Fixed space alignment Signed-off-by: Giulia Zanchi <[email protected]>
Co-authored-by: ScottH <[email protected]> Signed-off-by: Giulia Zanchi <[email protected]>
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.
LGTM
Merging this since both Jia and Scott approved the changes :) |
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.
Looks good, thanks!
I reviewed the README text, applying some layout improvements and minor copy edits.
I also added a new section, "Contributing guidelines", please provide feedback on that!