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

Update README.md #3630

Merged
merged 6 commits into from
Aug 20, 2024
Merged

Update README.md #3630

merged 6 commits into from
Aug 20, 2024

Conversation

giuliazanchi
Copy link
Contributor

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!

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]>
Copy link

codecov bot commented Aug 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.88%. Comparing base (b698daa) to head (350db15).
Report is 9 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@sharder996 sharder996 left a 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
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]>
@giuliazanchi
Copy link
Contributor Author

@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.

Copy link
Contributor

@andrei-toterman andrei-toterman left a 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 Show resolved Hide resolved
README.md Outdated
Description: Ubuntu 18.04.1 LTS
Release: 18.04
Codename: bionic
Distributor ID: Ubuntu
Copy link
Contributor

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?

Copy link
Contributor Author

@giuliazanchi giuliazanchi Aug 12, 2024

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.

Copy link
Contributor

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]>
README.md Show resolved Hide resolved
Co-authored-by: ScottH <[email protected]>
Signed-off-by: Giulia Zanchi <[email protected]>
Copy link
Contributor

@sharder996 sharder996 left a comment

Choose a reason for hiding this comment

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

LGTM

@giuliazanchi giuliazanchi added this pull request to the merge queue Aug 16, 2024
@giuliazanchi
Copy link
Contributor Author

Merging this since both Jia and Scott approved the changes :)

@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 16, 2024
Copy link
Collaborator

@ricab ricab left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@ricab ricab added this pull request to the merge queue Aug 20, 2024
@ricab ricab removed this pull request from the merge queue due to a manual request Aug 20, 2024
@ricab ricab merged commit 79a03da into main Aug 20, 2024
14 checks passed
@ricab ricab deleted the giuliazanchi-readme branch August 20, 2024 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants