Skip to content

Fix grammar typo and broken badge links in README#122

Open
tanodev0 wants to merge 1 commit into
nasa:mainfrom
tanodev0:fix/readme-typo-issue-11
Open

Fix grammar typo and broken badge links in README#122
tanodev0 wants to merge 1 commit into
nasa:mainfrom
tanodev0:fix/readme-typo-issue-11

Conversation

@tanodev0

@tanodev0 tanodev0 commented Jul 25, 2026

Copy link
Copy Markdown

Summary

  • Fixes typo in README.md #11 — "a application" → "an application" in the intro paragraph.
  • Also fixes the codecov and Snyk badge links, which had malformed nested markdown (](url (badge-url)%5D(url))) that rendered as broken/garbled URLs instead of clickable badges.

Test plan

  • Rendered README.md locally to confirm both badges render correctly and the intro sentence reads naturally.

Summary by CodeRabbit

  • Documentation
    • Corrected Codecov and “Known Vulnerabilities” badge formatting.
    • Improved grammar in the opening project description.

- "a application" -> "an application" (fixes nasa#11)
- codecov/Snyk badge links had malformed nested markdown that
  rendered broken URLs instead of clickable badges
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md updates correct the Codecov and Snyk badge Markdown and change “a application” to “an application” in the KMS 2.0 description.

Changes

README corrections

Layer / File(s) Summary
Badge formatting and introductory wording
README.md
Corrects Codecov and Snyk badge links and updates the opening KMS 2.0 description grammar.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: cgokey

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing required template sections like impacted areas, detailed testing, attachments, and the checklist. Fill in the full template with Overview, solution, impacted areas, reproduction/testing steps, attachments, and checklist items.
Out of Scope Changes check ⚠️ Warning The Codecov and Snyk badge-link edits are unrelated to linked issue #11, so the PR includes scope beyond the requested typo fix. Either document those badge fixes as part of the issue scope or split them into a separate PR focused on the README typo correction.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title concisely reflects the main README fix: a typo correction plus badge link repairs.
Linked Issues check ✅ Passed The typo fix directly satisfies issue #11's requirement to change 'a application' to 'an application' in the README.
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

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.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 3: Update the Codecov badge Markdown on line 3 so both the image URL and
hyperlink reference nasa/kms, replacing the nasa/mmt repository segment while
preserving the existing badge format and token.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e3dfae7a-c65c-4489-9f51-8a086a2e9257

📥 Commits

Reviewing files that changed from the base of the PR and between e55397c and 7599c3c.

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

Comment thread README.md
# KMS 2.0

[![codecov](https://codecov.io/gh/nasa/mmt/graph/badge.svg?token=B8Qspgsjou)](https://codecov.io/gh/nasa/kms (https://codecov.io/gh/nasa/mmt/graph/badge.svg?token=B8Qspgsjou)%5D(https://codecov.io/gh/nasa/kms))
[![codecov](https://codecov.io/gh/nasa/mmt/graph/badge.svg?token=B8Qspgsjou)](https://codecov.io/gh/nasa/kms)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Align the Codecov badge with the KMS repository.

Line 3 loads the badge from nasa/mmt but links to nasa/kms, so it may display coverage for the wrong project. Use the KMS repository in both URLs.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 3, Update the Codecov badge Markdown on line 3 so both the
image URL and hyperlink reference nasa/kms, replacing the nasa/mmt repository
segment while preserving the existing badge format and token.

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.

typo in README.md

1 participant