Skip to content

Move readme to md - #452

Merged
HarlemSquirrel merged 5 commits into
ruby-ldap:masterfrom
HarlemSquirrel:readme-to-md
Oct 13, 2026
Merged

HarlemSquirrel merged 5 commits into
ruby-ldap:masterfrom
HarlemSquirrel:readme-to-md

Conversation

@HarlemSquirrel

Copy link
Copy Markdown
Member

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The gemspec still references the removed README and excludes the replacement from the package.

1 open finding
What changed in this PR

Converts the project README from RDoc to Markdown.

Changes:

  • Replaces README.rdoc with README.md.
  • Updates formatting, badges, code blocks, and document links.
File Description
README.rdoc Removes the RDoc README.
README.md Adds the Markdown replacement.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

The new README documents an unsupported Ruby version and a nonexistent Docker Compose service.

0 open findings

1 resolved since last review
Previously missed (2)

In code that hasn't changed since last review

Low severity README states outdated Ruby 2.0 compatibility

README.md:31

The migrated README still claims Ruby 2.0 compatibility, but the gemspec requires Ruby >= 3.0.0 (and History.rdoc:10 records that requirement). This will mislead users on Ruby 2.x into attempting an installation that RubyGems rejects; update the documented minimum to match the package metadata.

Low severity README references nonexistent ci-2.7 service

README.md:74

This command references a service that no longer exists: docker-compose.yml defines ci-3.0 and newer services, not ci-2.7. Following the new README therefore fails immediately with “no such service”; use an available service (and the Compose v2 command used by CI).

🧠 Review effort: Balanced

@HarlemSquirrel
HarlemSquirrel marked this pull request as ready for review October 13, 2026 13:27
@HarlemSquirrel
HarlemSquirrel enabled auto-merge (squash) October 13, 2026 13:28
@HarlemSquirrel
HarlemSquirrel merged commit e830c7b into ruby-ldap:master Oct 13, 2026
8 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