Skip to content

docs: add status badges#7

Merged
donny-devops merged 1 commit into
mainfrom
chore/community-health-and-hygiene
Jul 7, 2026
Merged

docs: add status badges#7
donny-devops merged 1 commit into
mainfrom
chore/community-health-and-hygiene

Conversation

@donny-devops

Copy link
Copy Markdown
Owner

Adds CI, CodeQL, Gitleaks, and license status badges to the README for at-a-glance credibility.

- Add MIT LICENSE / SECURITY.md / CODE_OF_CONDUCT.md where missing
- Add CI/license status badges and architecture diagrams to key READMEs
- Reconcile documentation with actual repository state
Copilot AI review requested due to automatic review settings July 7, 2026 16:01
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This PR adds standard status badges to the README for CI, CodeQL, Gitleaks, and license information. The changes are documentation-only with no defects that block merge. The badge syntax is correct and follows GitHub/shields.io conventions. No issues found.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@sonarqubecloud

sonarqubecloud Bot commented Jul 7, 2026

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request adds several status badges (CI, CodeQL, Gitleaks, and MIT License) to the README.md file. The reviewer noted that the workflow files for CI, CodeQL, and Gitleaks do not yet exist in the repository, which would cause these badges to appear broken. A suggestion was provided to remove the non-existent workflow badges and clean up the spacing.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +3 to +8
[![CI](https://github.com/donny-devops/loop-engineering/actions/workflows/ci.yml/badge.svg)](https://github.com/donny-devops/loop-engineering/actions/workflows/ci.yml)
[![CodeQL](https://github.com/donny-devops/loop-engineering/actions/workflows/codeql.yml/badge.svg)](https://github.com/donny-devops/loop-engineering/actions/workflows/codeql.yml)
[![Gitleaks](https://github.com/donny-devops/loop-engineering/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/donny-devops/loop-engineering/actions/workflows/gitleaks.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)


Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The workflow files (ci.yml, codeql.yml, and gitleaks.yml) are not present in the repository. As a result, these status badges will display as broken or show a 'not found' error, which reduces the credibility of the repository.

Additionally, stacking the badges vertically takes up excessive vertical space, and there are multiple consecutive blank lines below them.

To resolve these issues, remove the non-existent workflow badges until the corresponding GitHub Actions workflows are added, and keep only a single blank line before the introduction paragraph.

Suggested change
[![CI](https://github.com/donny-devops/loop-engineering/actions/workflows/ci.yml/badge.svg)](https://github.com/donny-devops/loop-engineering/actions/workflows/ci.yml)
[![CodeQL](https://github.com/donny-devops/loop-engineering/actions/workflows/codeql.yml/badge.svg)](https://github.com/donny-devops/loop-engineering/actions/workflows/codeql.yml)
[![Gitleaks](https://github.com/donny-devops/loop-engineering/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/donny-devops/loop-engineering/actions/workflows/gitleaks.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds GitHub Actions and license badges to the top of the README to make build/security status visible at a glance.

Changes:

  • Added CI workflow status badge.
  • Added CodeQL workflow status badge.
  • Added Gitleaks workflow status badge and an MIT license badge linking to LICENSE.

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

@donny-devops donny-devops merged commit 74357cf into main Jul 7, 2026
11 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.

2 participants