Skip to content

Conversation

@Alenar
Copy link
Collaborator

@Alenar Alenar commented Jul 28, 2025

Content

This PR includes make all published projects have the same set of badge in the same order:

  • CI badge
  • Package repository badge (crates.io or npmjs.com)
  • License
  • Discord (IOG tech community)

Also all badges now links to their associated page instead of a link to the badge image.

Pre-submit checklist

  • Branch
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • All check jobs of the CI have succeeded
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • No new TODOs introduced

@Alenar Alenar self-assigned this Jul 28, 2025
@Alenar Alenar added the documentation 📖 Documentation to add/update label Jul 28, 2025
Copy link

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 standardizes badge displays across all published Mithril projects by adding a consistent set of badges in a unified order: CI workflow, package repository (crates.io or npmjs.com), license, and Discord community link. All badges now link to their associated pages rather than just displaying badge images.

  • Adds CI workflow badges to all README files
  • Standardizes badge order across all projects (CI, package repo, license, Discord)
  • Updates badge links to point to actual pages instead of badge images
  • Fixes crates.io package name references to match actual package names

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
mithril-common/README.md Adds CI badge and fixes crates.io link to point to mithril-stm instead of mithril-common
mithril-client/README.md Adds CI badge and updates license link to GitHub repository
mithril-client-wasm/README.md Adds CI badge and updates npm/license links to actual pages
internal/mithril-build-script/README.md Restructures badges onto separate line and updates links
internal/cardano-node/mithril-cardano-node-internal-database/README.md Adds full badge set to previously badge-less README

@github-actions
Copy link

github-actions bot commented Jul 28, 2025

Test Results

    4 files  ±0    154 suites  ±0   23m 21s ⏱️ +16s
2 118 tests ±0  2 118 ✅ ±0  0 💤 ±0  0 ❌ ±0 
6 466 runs  ±0  6 466 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit bdb7521. ± Comparison against base commit 1069937.

♻️ This comment has been updated with latest results.

@Alenar Alenar force-pushed the djo/better-badges-for-published-libs branch from 579710d to 6d13a2a Compare July 28, 2025 09:28
Make them all have the same set of badge in the same order:
- CI badge
- Package repository badge (crates.io or npmjs.com)
- License
- Discord (IOG tech community)

Also all badges now links to their associated page instead of a link to
the badge image.
@Alenar Alenar force-pushed the djo/better-badges-for-published-libs branch from 6d13a2a to bdb7521 Compare July 28, 2025 09:29
@Alenar Alenar temporarily deployed to testing-preview July 28, 2025 09:39 — with GitHub Actions Inactive
Copy link
Collaborator

@turmelclem turmelclem left a comment

Choose a reason for hiding this comment

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

LGTM 🧋

@Alenar Alenar merged commit 78f6fcd into main Jul 28, 2025
41 checks passed
@Alenar Alenar deleted the djo/better-badges-for-published-libs branch July 28, 2025 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📖 Documentation to add/update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants