Skip to content

Add project badges to README #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mangelajo merged 2 commits into from
Dec 3, 2025
Merged

Add project badges to README #197

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca4f06e
Add project badges to README
the78mole Nov 30, 2025
0d84b83
Apply suggestions from code review
mangelajo Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# jumpstarter-router
# jumpstarter-controller

[![Build and push container image](https://github.com/jumpstarter-dev/jumpstarter-controller/actions/workflows/build.yaml/badge.svg)](https://github.com/jumpstarter-dev/jumpstarter-controller/actions/workflows/build.yaml)
![GitHub Release](https://img.shields.io/github/v/release/jumpstarter-dev/jumpstarter-controller)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/jumpstarter-dev/jumpstarter-controller/total)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/jumpstarter-dev/jumpstarter-controller)

// TODO(user): Add simple overview of use/purpose
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 30, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Replace C-style TODO comments with proper markdown syntax or remove before merge.

The README contains C-style comments (// TODO(user):) which are not valid markdown syntax and will render as plain text to users. Since this is a public-facing README, these should either be:

  • Converted to HTML comments: <!-- TODO(user): ... -->
  • Or removed entirely after content is added

This gives the impression the README is incomplete or uses a template that hasn't been properly customized.

Consider one of the following approaches:

Option 1: Convert to HTML comments (if these are meant as internal notes for contributors)

-// TODO(user): Add simple overview of use/purpose
+<!-- TODO(user): Add simple overview of use/purpose -->

Option 2: Remove the TODO comments (recommended for a public README)

-// TODO(user): Add simple overview of use/purpose

 ## Description
-// TODO(user): An in-depth paragraph about your project and overview of use

Or fill in the actual content instead of leaving TODO placeholders.

Also applies to: 11-11, 98-98

🤖 Prompt for AI Agents 
In README.md around lines 8, 11 and 98, there are C-style TODO comments (//
TODO(...)) which are not valid Markdown; replace each with either an HTML
comment (<!-- TODO(...) -->) if you want to keep internal notes, remove them
entirely, or replace them with actual README content; ensure no C-style comment
tokens remain and that any retained notes use proper Markdown/HTML comment
syntax or are converted into real documentation text.


## Description
Expand Down
Loading