Skip to content

feat: add comprehensive AI assistant guide for Wrappers project#569

Open
burmecia wants to merge 1 commit intosupabase:mainfrom
burmecia:claude/claude-md-ml7yfvtu0npj00jp-4S6fv
Open

feat: add comprehensive AI assistant guide for Wrappers project#569
burmecia wants to merge 1 commit intosupabase:mainfrom
burmecia:claude/claude-md-ml7yfvtu0npj00jp-4S6fv

Conversation

@burmecia
Copy link
Member

@burmecia burmecia commented Feb 4, 2026

Summary

This PR adds CLAUDE.md, a comprehensive guide designed to help AI assistants understand the Wrappers project structure, architecture, and development workflows. This document serves as a reference for code generation, debugging, and contributing to the project.

Key Changes

  • Project Overview: Documented the purpose of Wrappers as a PostgreSQL FDW framework written in Rust
  • Repository Structure: Mapped out the workspace organization including core framework, native FDWs, and Wasm FDWs
  • Core Components: Detailed the ForeignDataWrapper trait interface with all required and optional methods
  • Data Types Reference: Documented key types like Cell, Row, Column, Qual, Sort, and Limit
  • Available FDWs: Created a comprehensive table of all 15 native FDWs and 12 Wasm FDWs with write support indicators
  • Development Workflows: Provided step-by-step instructions for:
    • Prerequisites and toolchain setup
    • Building native and Wasm FDWs
    • Running interactive development with pgrx
    • Testing with Docker Compose
    • Code quality checks (fmt, clippy)
  • Code Patterns: Included practical examples for:
    • Error handling with custom error types
    • FDW implementation template
    • File organization conventions
    • Query pushdown usage
  • Common Tasks: Documented procedures for adding new FDWs, debugging, and working with options
  • CI/CD Reference: Listed GitHub Actions workflows for testing and releases
  • Important Notes: Highlighted key constraints like native FDW contribution restrictions and materialized view caveats

Implementation Details

The guide is structured to be both a learning resource and a quick reference, with:

  • Clear code examples using actual patterns from the codebase
  • Feature flag mappings for PostgreSQL version support
  • Workspace configuration details (Rust 1.88.0, pgrx 0.16.1)
  • Links to external documentation (fdw.dev, docs.rs)

This document will help AI assistants provide more accurate and contextual assistance when working on Wrappers-related tasks.

https://claude.ai/code/session_01EYhGdmQMcA4JJK69tXTUYq

Comprehensive documentation for AI assistants including:
- Repository structure and workspace configuration
- ForeignDataWrapper trait and core interfaces
- Development workflows (building, testing, debugging)
- Code patterns and conventions for FDW implementations
- Available native and Wasm FDWs
- CI/CD pipelines and contribution guidelines

https://claude.ai/code/session_01EYhGdmQMcA4JJK69tXTUYq
Copilot AI review requested due to automatic review settings February 4, 2026 11:50
@burmecia burmecia added the enhancement New feature or request label Feb 4, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds CLAUDE.md, an AI-assistant–focused guide that documents the Wrappers project’s architecture, core traits and types, FDW inventory, and standard development workflows. It is intended as a central reference for automated tools generating or reviewing code in this repository.

Changes:

  • Added a high-level project and workspace overview, including key components (ForeignDataWrapper trait, core types, and macros).
  • Documented native and Wasm FDWs, along with build, test, and CI/CD workflows, and common implementation patterns (error handling, FDW layout, query pushdown, options handling).
  • Captured contribution-related guidance and operational notes (feature flags, version support, rowid semantics, and contribution preferences for Wasm vs native FDWs).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@burmecia burmecia requested a review from imor February 5, 2026 00:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants