Skip to content

Reorganize badges on README#1483

Merged
minggangw merged 2 commits intoRobotWebTools:developfrom
minggangw:fix-1482
Apr 9, 2026
Merged

Reorganize badges on README#1483
minggangw merged 2 commits intoRobotWebTools:developfrom
minggangw:fix-1482

Conversation

@minggangw
Copy link
Copy Markdown
Member

@minggangw minggangw commented Apr 9, 2026

Changes

README.md

Badges (lines 3–8):

  • Reorganized from 9 badges on a single line to 6 focused badges, each on its own line: npm version, npm downloads, GitHub stars, coverage, Node version, TypeScript
  • Removed lower-value badges: license (visible in repo sidebar), code style (developer-facing), last commit (redundant with CI table)

CI status table (lines 10–12):

  • Renamed headers: ROS Distro*ROS 2 Distro, StatusCI Status
  • Replaced plain text distro list with a ROS 2 badge showing all supported distros
  • Stacked CI badges vertically with <br> for proportional scaling
  • Simplified table separator to minimal | :---: | :---: |
  • Removed orphaned footnote note

Intro (line 14):

  • Added one-line feature highlights

Performance table (line 246):

  • Right-aligned numeric columns for readability

.prettierignore (new)

  • Exclude README.md and scripts/npmjs-readme.md from Prettier auto-formatting to prevent table separator padding from being re-expanded on commit

Fix: #1482

Copilot AI review requested due to automatic review settings April 9, 2026 05:09
Copy link
Copy Markdown

Copilot AI left a comment

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 project’s README presentation by reorganizing the top-level badges/CI status section and lightly reformatting the benchmarks section to improve readability.

Changes:

  • Split the single-line badge block into multiple lines and add a GitHub stars badge.
  • Replace the ROS distro/CI status table with a ROS 2 “supported distros” badge plus per-platform workflow badges.
  • Reformat the Performance Benchmarks table for numeric alignment and move the methodology note after the table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +3 to +8
[![npm](https://img.shields.io/npm/v/rclnodejs)](https://www.npmjs.com/package/rclnodejs)
[![npm downloads](https://img.shields.io/npm/dm/rclnodejs)](https://www.npmjs.com/package/rclnodejs)
[![GitHub stars](https://img.shields.io/github/stars/RobotWebTools/rclnodejs)](https://github.com/RobotWebTools/rclnodejs/stargazers)
[![Coverage Status](https://coveralls.io/repos/github/RobotWebTools/rclnodejs/badge.svg?branch=develop)](https://coveralls.io/github/RobotWebTools/rclnodejs?branch=develop)
[![node](https://img.shields.io/node/v/rclnodejs)](https://nodejs.org/en/download/releases/)
[![TypeScript](https://img.shields.io/npm/types/rclnodejs)](https://www.npmjs.com/package/rclnodejs)
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

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

The PR title says this is a reorganization of badges, but this change also drops the GitHub license badge and the Prettier/code-style badge (previously present in the single-line badge row). If the intent is only to reorder, consider re-adding those badges or clarify that removing them is desired.

Copilot uses AI. Check for mistakes.
README.md Outdated
Comment on lines +10 to +11
| **ROS 2 Distro** | **CI Status** |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

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

The Markdown table header/separator uses extremely long runs of spaces and dashes, which makes the README harder to edit and increases diff noise without affecting rendering. Consider simplifying the table header and alignment row to a minimal form (e.g., standard | --- | --- |) while keeping the same displayed content.

Suggested change
| **ROS 2 Distro** | **CI Status** |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **ROS 2 Distro** | **CI Status** |
| :---: | :---: |

Copilot uses AI. Check for mistakes.
@coveralls
Copy link
Copy Markdown

coveralls commented Apr 9, 2026

Coverage Status

coverage: 85.844%. remained the same — minggangw:fix-1482 into RobotWebTools:develop

@minggangw minggangw merged commit 1af7e77 into RobotWebTools:develop Apr 9, 2026
30 of 32 checks passed
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.

Reorganize badges on README

3 participants