Update README.md badges and improve markdown settings by AlphaOne1 · Pull Request #34 · AlphaOne1/geany

AlphaOne1 · 2025-08-09T13:12:43Z

Summary by CodeRabbit

Documentation
- Updated README to improve security by adding noopener noreferrer to external links.
- Added a "CodeRabbit Reviews" badge.
- Updated GoDoc badge links and images to use pkg.go.dev.
- Cleaned up whitespace in ASCII art and revision lines.
- Added markdownlint directives for badge section formatting.
Chores
- Updated markdownlint configuration to enforce a 120-character line length limit.

- Added `noopener noreferrer` to external links for security enhancement. - Replaced outdated GoDoc badge with pkg.go.dev badge. - Disabled and re-enabled specific markdownlint rules for readability. - Updated `.markdownlint.json` to allow longer lines (`MD013`).

coderabbitai · 2025-08-09T13:12:51Z

Walkthrough

The changes update the markdownlint configuration to enforce a maximum line length of 120 characters and revise the README.md for improved security, updated badge links, and minor formatting adjustments. No functional code or public API changes are present.

Changes

Cohort / File(s)	Change Summary
Markdownlint Configuration `.markdownlint.json`	Added rule MD013 to set line length limit to 120 characters; minor formatting adjustment for trailing comma.
README and Badges `README.md`	Updated badge URLs, added CodeRabbit Reviews badge, enhanced anchor tag security, and performed whitespace cleanup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Hopping through docs with badges anew,
A rabbit tweaks links for a safer view.
Lint rules set for lines not too long,
Markdown shines where badges belong.
With every hop, the docs grow bright—
Neat and secure, all lines just right!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c12897 and f3d8575.

📒 Files selected for processing (1)

README.md (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

README.md

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch add_coderabbit_badge

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov-commenter · 2025-08-09T13:14:08Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

.markdownlint.json (1)
1-6: Optional: Tweak MD013 to ignore code blocks/tables to reduce noise

Given README contains badges, ASCII art, and long code lines, consider excluding code blocks/tables from MD013 to prevent false positives.

Apply this diff:
 {
     "default": true,
     "MD003": { "style": "setext_with_atx" },
     "MD007": { "indent": 2 },
-    "MD013": { "line_length": 120 }
+    "MD013": {
+      "line_length": 120,
+      "heading_line_length": 0,
+      "code_block_line_length": 0,
+      "code_blocks": false,
+      "tables": false
+    }
 }
README.md (1)
36-41: Nit: Spelling in commented alt text

If you ever re-enable this badge, consider US spelling for consistency: “Practices” instead of “Practises”.
-             alt="OpenSSF Best Practises">
+             alt="OpenSSF Best Practices">

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f76139f and 7c12897.

📒 Files selected for processing (2)

.markdownlint.json (1 hunks)
README.md (4 hunks)

🔇 Additional comments (5)

.markdownlint.json (1)

5-5: MD013 addition and 120-char limit look good

This aligns with the README changes and is a reasonable limit.

README.md (4)

1-1: Good use of markdownlint disable/enable fence around the badge HTML

This cleanly scopes MD013/MD033/MD041 to just the badges section.

Also applies to: 67-67

4-65: Security hardening on external links is solid

Adding rel="noopener noreferrer" on all target=_blank links mitigates tabnabbing. Consistent across all anchors.

60-65: Nice update to pkg.go.dev badge/link

This replaces deprecated godoc.org and follows current best practice.

34-35: Badge Endpoint Validated

The CodeRabbit shields URL (https://img.shields.io/coderabbit/prs/github/AlphaOne1/geany) returns HTTP 200 and renders correctly.

No updates to the README badge are required.

AlphaOne1 self-assigned this Aug 9, 2025

coderabbitai Bot reviewed Aug 9, 2025

View reviewed changes

Comment thread README.md

Remove unused token from Codecov badge link in README.md

f3d8575

AlphaOne1 merged commit 9f4d005 into master Aug 9, 2025
13 checks passed

AlphaOne1 deleted the add_coderabbit_badge branch August 9, 2025 13:24

coderabbitai Bot mentioned this pull request Aug 9, 2025

Update codecov badge. #35

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update README.md badges and improve markdown settings#34

Update README.md badges and improve markdown settings#34
AlphaOne1 merged 2 commits into
masterfrom
add_coderabbit_badge

AlphaOne1 commented Aug 9, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 9, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov-commenter commented Aug 9, 2025

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

AlphaOne1 commented Aug 9, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov-commenter commented Aug 9, 2025

Codecov Report

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

AlphaOne1 commented Aug 9, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)