Skip to content

Conversation

@Aditya7015
Copy link

@Aditya7015 Aditya7015 commented Dec 13, 2025

Added a GitHub Actions badge to the README to show CI/test status.

Fixes #11

Summary by CodeRabbit

  • Documentation
    • Added a CI test status badge to the README for improved visibility of test results.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 13, 2025

Walkthrough

A CI test status badge was added to the top of README.md, linking to the test results. This provides immediate visibility of the test status for repository visitors. The content and structure of the rest of the documentation remain unchanged.

Changes

Cohort / File(s) Summary
CI Badge Addition
README.md
Added Markdown badge line at the top of the file linking to CI tests. Surrounding whitespace adjusted for formatting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single file modification with a straightforward badge addition
  • No logic, code, or structural changes involved
  • Simple Markdown formatting update

Poem

🐰 A badge shines bright at the README's peak,
Displaying test glory, no code to critique!
With one little line, the status is clear,
The tests are all passing—let's give a big cheer! ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add tests passing badge to README' directly describes the main change: adding a badge to the README file that shows test status.
Linked Issues check ✅ Passed The pull request adds a badge to README displaying CI/test status as required by issue #11, fulfilling the objective to show test passing status to contributors and users.
Out of Scope Changes check ✅ Passed The changes are limited to adding a badge to README.md with no modifications to code, functionality, or other unrelated files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c690d2 and 0007791.

📒 Files selected for processing (1)
  • README.md (1 hunks)

@@ -1,3 +1,6 @@
[![Tests](https://github.com/StabilityNexus/Oracle-Solidity/actions/workflows/CI.yml/badge.svg)](https://github.com/StabilityNexus/Oracle-Solidity/actions)
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

# Check for workflow files in .github/workflows/
fd -e yml -e yaml . .github/workflows/ 2>/dev/null || echo "No workflows found"

Repository: DjedAlliance/Oracle-Solidity

Length of output: 96


🏁 Script executed:

# Check if .github/workflows directory exists and list its contents
if [ -d .github/workflows ]; then
  echo "=== Workflow files found ==="
  ls -la .github/workflows/
else
  echo "=== No .github/workflows directory found ==="
fi

Repository: DjedAlliance/Oracle-Solidity

Length of output: 264


🏁 Script executed:

# Check git remote origin to determine actual repository
git config --get remote.origin.url 2>/dev/null || echo "No git remote found"

Repository: DjedAlliance/Oracle-Solidity

Length of output: 123


🏁 Script executed:

# Check for any README or config files that might indicate the correct org
head -20 README.md 2>/dev/null || echo "README.md not found or empty"

Repository: DjedAlliance/Oracle-Solidity

Length of output: 580


Incorrect GitHub organization in badge URL.

The badge URL references StabilityNexus/Oracle-Solidity but the repository is DjedAlliance/Oracle-Solidity. This causes the badge to fetch CI status from the wrong repository and directs users to the wrong repository's CI workflow.

Apply this diff to fix the organization name:

-[![Tests](https://github.com/StabilityNexus/Oracle-Solidity/actions/workflows/CI.yml/badge.svg)](https://github.com/StabilityNexus/Oracle-Solidity/actions)
+[![Tests](https://github.com/DjedAlliance/Oracle-Solidity/actions/workflows/CI.yml/badge.svg)](https://github.com/DjedAlliance/Oracle-Solidity/actions)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[![Tests](https://github.com/StabilityNexus/Oracle-Solidity/actions/workflows/CI.yml/badge.svg)](https://github.com/StabilityNexus/Oracle-Solidity/actions)
[![Tests](https://github.com/DjedAlliance/Oracle-Solidity/actions/workflows/CI.yml/badge.svg)](https://github.com/DjedAlliance/Oracle-Solidity/actions)
🤖 Prompt for AI Agents
In README.md around lines 1 to 1, the GitHub Actions badge points to the wrong
organization; update the badge URL and link target to use
DjedAlliance/Oracle-Solidity instead of StabilityNexus/Oracle-Solidity so the CI
status and link reference the correct repository and workflow.

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.

Add badge showing that tests are passing in the Oracle repo

1 participant