Skip to content

docs: point CLAUDE.md at src/connectors/interface.ts - #447

Merged
tianzhou merged 1 commit into
bytebase:mainfrom
roli-lpci:dbhub-claudemd-connector-path
Oct 1, 2026
Merged

tianzhou merged 1 commit into
bytebase:mainfrom
roli-lpci:dbhub-claudemd-connector-path

Conversation

@roli-lpci

Copy link
Copy Markdown
Contributor

What

A one-line fix in the "Database Connectors" section of CLAUDE.md:

-- Implement the `Connector` and `DSNParser` interfaces from `src/interfaces/connector.ts`
+- Implement the `Connector` and `DSNParser` interfaces from `src/connectors/interface.ts`

Why

src/interfaces/connector.ts no longer exists. 1f9c511 ("refactor: move connector interface") renamed it to src/connectors/interface.ts, and both interfaces live there at 8c09c86 (DSNParser at line 186, Connector at line 210). The line was not updated at the time, so anyone (or any coding agent) following the guide to add a connector gets sent to a missing file. This was the only reference to the old path in the repo.

Checks

  • Docs-only change: no code, test, or build file is touched. No test or script reads CLAUDE.md.
  • Found with lintlang, a deterministic, rule-based linter for agent instruction files. Checked against the tree at 8c09c86: lintlang scan CLAUDE.md (0.8.1) reports REVIEW (1 medium, H4.5: referenced path does not exist) on the base and PASS (0 findings) on this branch.

This contribution was autonomously selected and produced by agents through Hermes Labs’ engineering infrastructure. Rolando Bosch is the responsible human contributor and authorized publication from his personal GitHub account.

@roli-lpci
roli-lpci requested a review from tianzhou as a code owner September 29, 2026 23:58
Copilot AI balanced review requested due to automatic review settings September 29, 2026 23:58

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.

Copilot review overview

🟢 Approval recommended

The corrected path exists and contains both documented interfaces.

Review effort: Balanced
Findings: None

What changed in this PR

Corrects outdated connector-development documentation to reference the existing interface file.

Changes:

  • Updates the Connector and DSNParser interface path.
File Description
CLAUDE.md Points connector guidance to src/connectors/interface.ts.

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

@tianzhou tianzhou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@tianzhou
tianzhou merged commit c02dfc8 into bytebase:main Oct 1, 2026
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