feat: add comprehensive AI assistant guide for Wrappers project#569
Open
burmecia wants to merge 1 commit intosupabase:mainfrom
Open
feat: add comprehensive AI assistant guide for Wrappers project#569burmecia wants to merge 1 commit intosupabase:mainfrom
burmecia wants to merge 1 commit intosupabase:mainfrom
Conversation
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
Contributor
There was a problem hiding this comment.
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 (
ForeignDataWrappertrait, 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
ForeignDataWrappertrait interface with all required and optional methodsCell,Row,Column,Qual,Sort, andLimitImplementation Details
The guide is structured to be both a learning resource and a quick reference, with:
This document will help AI assistants provide more accurate and contextual assistance when working on Wrappers-related tasks.
https://claude.ai/code/session_01EYhGdmQMcA4JJK69tXTUYq