README: add three more status buttons - #11650
Conversation
The 3 new buttons added are: - Good first issue - Read the Docs build status - CloudStack website status
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11650 +/- ##
============================================
+ Coverage 3.41% 19.64% +16.23%
- Complexity 0 19790 +19790
============================================
Files 487 6368 +5881
Lines 41867 574889 +533022
Branches 7912 70353 +62441
============================================
+ Hits 1429 112962 +111533
- Misses 40238 449656 +409418
- Partials 200 12271 +12071
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates the repository README to add additional badges that surface project links/status signals near the top of the document.
Changes:
- Added a “Good first issue” badge linking to issues with the
good-first-issuelabel. - Added a Read the Docs documentation build/status badge for the CloudStack documentation project.
- Added a CloudStack website availability/status badge.
Suppressed comments (1)
README.md:35
- The website status badge URL is split across two lines, which breaks the Markdown link/image syntax and can prevent the badge from rendering. Keep the badge on a single line so the
https://img.shields.io/website?...URL is not newline-terminated.
[](https://cloudstack.apache.org/)
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| [](https://github.com/apache/cloudstack/actions/workflows/ci.yml) | ||
| [](https://github.com/apache/cloudstack/actions/workflows/ui.yml) | ||
|
|
||
| [](https://github.com/apache/cloudstack/issues?q=is%3Aissue%20state%3Aopen%20label%3Agood-first-issue) |
|
@winterhazel , readme only, care to merge? |
|
Hi @winterhazel @weizhouapache please advise if this one can be merged on main branch (to be included on 4.23 RC3), if so can you also please update the milestone to 4.23? |
|
README-only change, so merging. |
The 3 new buttons added are:
Description
This PR enhances the visibility of the project by adding helpful links.
The good first issue button is very helpful it helps onboard new GitHubbers quicker and directs them to easier issues.
Example here:
https://github.com/jbampton/cloudstack/tree/add-readme-badges?tab=readme-ov-file#apache-cloudstack
And seen in this image:
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
Visually and with a screenshot as it is only editing the README
How did you try to break this feature and the system with this change?