Skip to content

Add libsql-conformance to the README and CONTRIBUTING module inventory #170

Closed

Description

@magnusp

Problem

README.md §Modules and CONTRIBUTING.md §Project Structure list only four modules (libsql-jdbc, libsql-client, libsql-hrana-codec, libsql-itests). The fifth module, libsql-conformance, is missing from both even though it is a first-class module in the root pom.xml and has its own README.

AGENTS.md §2 already lists all five. The three documents disagree.

Proposed change

  • Add libsql-conformance to the README.md module table with a one-line description and a link to libsql-conformance/README.md.
  • Add libsql-conformance to the CONTRIBUTING.md project-structure list.
  • Make the three inventories consistent in order and wording.

Acceptance criteria

  • README.md, CONTRIBUTING.md, and AGENTS.md all name the same five modules.
  • README.md links to libsql-conformance/README.md.

Activity

  1. added
    documentationImprovements or additions to documentation
    P2Normal priority: edge case, feature gap, or test/process improvement
    on Oct 23, 2026
  2. magnusp commented on Oct 24, 2026

    @magnusp
    OwnerAuthor

    Implemented in #177, merged to main in fc3f819.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Normal priority: edge case, feature gap, or test/process improvementdocumentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions