Skip to content

Improve adaptor generation and review guidance - #1829

Open
mtuchi wants to merge 5 commits into
mainfrom
adaptor-gen-guidance
Open

mtuchi wants to merge 5 commits into
mainfrom
adaptor-gen-guidance

Conversation

@mtuchi

@mtuchi mtuchi commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Update the adaptor generation and code review guidance, based on problems found reviewing the AI-generated copper and lemlist adaptors (#1828).

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

  • I have used Claude Code
  • I have used another model
  • I have not used AI

You can read more details in our
Responsible AI Policy

Review Checklist

Before merging, the reviewer should check the following items:

  • Does the PR do what it claims to do?
  • If this is a new adaptor, added the adaptor on marketing website ?
  • If this PR includes breaking changes, do we need to update any jobs in
    production? Is it safe to release?
  • Are there any unit tests?
  • Is there a changeset associated with this PR? Should there be? Note that
    dev only changes don't need a changeset.
  • If there is a changeset, was pnpm run version used to bump versions (not
    pnpm changeset version directly)? This ensures changelog dates are stamped correctly.
  • Have you ticked a box under AI Usage?

Fix stale paths in claude.md and copilot instructions, add a self-review
step and design rules for generated adaptors, document pagination and
state conventions in best-practice, and fold recurring maintainer review
feedback into wiki/code-review.md.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@taylordowns2000

Copy link
Copy Markdown
Member

@mtuchi , was this better or worse for Jack's open street map adaptor? I think that's the most interesting data point we have when deciding if we should merge this pr.

Cc @josephjclark , @hunterachieng , @PiusKariuki

@mtuchi mtuchi self-assigned this Oct 28, 2026
mtuchi and others added 4 commits October 30, 2026 15:04
Scope the apiVersion rule to versioned APIs with a default set in code,
note the override trade-off, clarify how common's request surfaces upstream
errors, and require tests per index.js export. Add rules for client-side
validation and multi-page pagination tests. Bring copilot-instructions in
line with claude.md and import from index.js in the generator test template.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
From review of the openstreetmap adaptor (#1833): name functions with a
verb for what they do rather than after the endpoint they call, and put
the unit in option names that have one.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01De8BkeiGnA7aM4fARhetDC
Rewrite the pagination rules to cover any operation that returns a
collection and any paging style (offset, page number, cursor, next link),
and align claude.md and code-review.md with them. Restore the Utils.js and
Adaptor.js request signatures in copilot-instructions, matching the
generator template.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mtuchi
mtuchi requested a review from hunterachieng October 30, 2026 14:42
@mtuchi

mtuchi commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator Author

Hey @PiusKariuki or @hunterachieng can you take a look at this pr when you have capacity ?

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants