Skip to content

docs: update README badges layout and add Version badge#16868

Open
Ibochkarev wants to merge 3 commits intomodxcms:3.xfrom
Ibochkarev:docs/readme-badges
Open

docs: update README badges layout and add Version badge#16868
Ibochkarev wants to merge 3 commits intomodxcms:3.xfrom
Ibochkarev:docs/readme-badges

Conversation

@Ibochkarev
Copy link
Collaborator

@Ibochkarev Ibochkarev commented Feb 23, 2026

What does it do?

  • Splits README badge links onto separate lines for readability.
  • Adds a Version badge (GitHub tag).

Why is it needed?

Improves readability of the badge block and keeps the Build Status link correct; the Version badge provides quick access to the current release tag.

How to test

Open README.md in the repo and confirm badges are on separate lines, Build Status links to the correct CI workflow, and the Version badge displays the tag.

Related issue(s)/PR(s)

None.

- Split badge links onto separate lines for readability
- Point Build Status to ci.yml workflow
- Add Version badge (GitHub tag)
@Ibochkarev Ibochkarev marked this pull request as ready for review February 23, 2026 05:13
[![Version](https://img.shields.io/github/v/tag/modxcms/revolution)](https://github.com/modxcms/revolution/tags)
[![codecov](https://codecov.io/github/modxcms/revolution/branch/3.x/graph/badge.svg?token=sJMrBYbkA6)](https://app.codecov.io/github/modxcms/revolution)
[![Contributors](https://img.shields.io/github/contributors/modxcms/revolution.svg)](https://github.com/modxcms/revolution/graphs/contributors)
[![Slack Chat](https://img.shields.io/badge/chat_in_slack-online-green.svg?longCache=true&style=flat&logo=slack)](https://modx.org)
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe replace with this? See here: https://community.modx.com/t/reorganise-the-community-discussion-forum-github-discussions-and-slack/8979/6

https://img.shields.io/discourse/posts?server=https%3A%2F%2Fcommunity.modx.com%2F&style=flat&logo=discourse&label=MODX%20Community

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd keep Slack, it's still in active use even if your points about in-depth discussions being better on the forum is valid.

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps we should add both until I can convince @Mark-H that Slack is not the right choice for the future ❤️

Copy link
Member

Choose a reason for hiding this comment

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

Is there any downside to having both?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@biz87
Copy link

biz87 commented Feb 25, 2026

Code Review

Summary

Updates README.md badges layout: splits the single-line badge string into separate lines for readability, adds a Version badge (GitHub tag) and a Support MODX badge (Open Collective), and updates the Twitter badge to use the X logo.

Assessment

Simple documentation improvement. Badges on separate lines improve readability of the raw markdown. The new badges (Version, Support) provide useful project information. The Twitter-to-X logo update is current.

Verdict: Approve

Copy link
Member

@mkschell mkschell left a comment

Choose a reason for hiding this comment

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

Visually confirmed. Docs-only change. Badge reformatting and CI URL fix are welcome. Compromise reached re: Slack & Community badges.

badges section of README

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.

5 participants