Skip to content

README: add three more status buttons - #11650

Merged
winterhazel merged 6 commits into
apache:mainfrom
jbampton:add-readme-badges
Aug 12, 2026
Merged

README: add three more status buttons#11650
winterhazel merged 6 commits into
apache:mainfrom
jbampton:add-readme-badges

Conversation

@jbampton

Copy link
Copy Markdown
Member

The 3 new buttons added are:

  • Good first issue
  • Read the Docs build status
  • CloudStack website status

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:

Screenshot from 2025-09-17 04-25-56

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • build/CI
  • test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

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?

The 3 new buttons added are:

- Good first issue
- Read the Docs build status
- CloudStack website status
@codecov

codecov Bot commented Sep 16, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 19.64%. Comparing base (1ceb1d0) to head (48fc1cc).

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     
Flag Coverage Δ
uitests 3.41% <ø> (ø)
unittests 20.92% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jbampton
jbampton requested a review from vishesh92 September 17, 2025 23:55
@jbampton
jbampton requested review from Pearl1594 and nvazquez March 17, 2026 12:12
@jbampton jbampton self-assigned this Mar 17, 2026
@jbampton jbampton removed their assignment Mar 31, 2026
@weizhouapache weizhouapache added this to the 4.24.0 milestone Jun 29, 2026
Copilot AI lite review requested due to automatic review settings August 12, 2026 08:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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-issue label.
  • 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.
[![CloudStack Website Status](https://img.shields.io/website?url=https%3A%2F%2Fcloudstack.apache.org%2F
)](https://cloudstack.apache.org/)

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md
[![Simulator CI](https://github.com/apache/cloudstack/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/ci.yml)
[![UI Build](https://github.com/apache/cloudstack/actions/workflows/ui.yml/badge.svg?branch=main)](https://github.com/apache/cloudstack/actions/workflows/ui.yml)

[![Good First Issues](https://img.shields.io/badge/good%20first%20issues-94D5DA)](https://github.com/apache/cloudstack/issues?q=is%3Aissue%20state%3Aopen%20label%3Agood-first-issue)
@DaanHoogland

Copy link
Copy Markdown
Contributor

@winterhazel , readme only, care to merge?

@nvazquez

Copy link
Copy Markdown
Contributor

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?

@winterhazel

Copy link
Copy Markdown
Member

README-only change, so merging.

@winterhazel
winterhazel merged commit 659f675 into apache:main Aug 12, 2026
25 of 27 checks passed
@nvazquez nvazquez modified the milestones: 4.24.0, 4.23.0 Aug 12, 2026
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.

7 participants