Skip to content

[DSD-10018]Updated README.md tp test sonar changes.#198

Merged
ckm007 merged 1 commit intomosip:release-1.4.xfrom
Mahesh-Binayak:patch-2
Mar 30, 2026
Merged

[DSD-10018]Updated README.md tp test sonar changes.#198
ckm007 merged 1 commit intomosip:release-1.4.xfrom
Mahesh-Binayak:patch-2

Conversation

@Mahesh-Binayak
Copy link
Copy Markdown
Contributor

@Mahesh-Binayak Mahesh-Binayak commented Mar 27, 2026

Summary by CodeRabbit

  • Documentation
    • Refined README formatting and punctuation for improved readability.
    • Enhanced clarity of instructional text describing available options.

Signed-off-by: Mahesh-Binayak <76687012+Mahesh-Binayak@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 27, 2026

Walkthrough

The README.md file was updated with minor formatting and wording adjustments. A section header spacing was modified and instructional text was rephrased for clarity, with no functional or structural changes introduced.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added spacing before trailing question mark in section header; rephrased instructional text from "There are two ways:" to "There are two ways to do that:" for improved clarity.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A readme once lived, quite plain to see,
With spacing and words, a bit awkwardly.
Our hop-skip refine made it clearer today—
Two ways now shine in a brighter way!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title contains a typo ('tp' instead of 'to') and is vague about actual changes. It mentions testing Sonar changes but the PR only updates README formatting, which is unrelated to Sonar quality checks. Revise the title to accurately describe the changes, such as 'Update README.md formatting and punctuation' or 'Fix README.md spacing and sentence structure'. Remove reference to Sonar changes if not applicable.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

Copy link
Copy Markdown

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 15-16: Update the heading "How to use the plugin with fixes where
the eSignet is not yet released ?" to cleaner grammar and punctuation by
removing the space before the question mark and tightening the phrasing — e.g.,
change the title referenced as "How to use the plugin with fixes where the
eSignet is not yet released ?" to "How to use the plugin with fixes when eSignet
is not yet released" or "Using the plugin with fixes before eSignet is released"
to improve readability and consistency.
🪄 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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 9c22d402-6a40-45e3-ba24-d959f5044b0c

📥 Commits

Reviewing files that changed from the base of the PR and between df10b8e and 2b753a6.

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

Copy link
Copy Markdown

@vadherhemant vadherhemant left a comment

Choose a reason for hiding this comment

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

Approved

@ckm007 ckm007 merged commit 399bc4c into mosip:release-1.4.x Mar 30, 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.

3 participants