first review

This commit is contained in:
Pedro Rodrigues
2026-01-21 16:10:36 +00:00
parent 16027b1609
commit 5c9d145adf
5 changed files with 12 additions and 20 deletions

View File

@@ -5,7 +5,7 @@ etc.) when working with code in this repository.
## Repository Overview ## Repository Overview
A collection of Postgres best practices skills for Claude.ai and Claude Code, A collection of Postgres best practices skills for AI coding agents,
maintained by Supabase. Skills are packaged instructions that extend agent maintained by Supabase. Skills are packaged instructions that extend agent
capabilities for database optimization. capabilities for database optimization.

View File

@@ -1,8 +1,9 @@
# Supabase Agent Skills # Supabase Agent Skills
Battle-tested database expertise from Supabase, packaged as AI agent skills. Agents skills to help you develope with Supabase. These skills provide AI coding
These skills provide AI coding agents with proven patterns for building and agents like Claude Code, Cursor, Github Copilot, etc... with specialized
optimizing production Postgres applications. instructions for building and optimizing production Postgres and Supabase
applications.
Skills follow the [Agent Skills](https://agentskills.io/) format. Skills follow the [Agent Skills](https://agentskills.io/) format.

View File

@@ -10,7 +10,7 @@ January 2026
## Abstract ## Abstract
Comprehensive PostgreSQL performance optimization guide for developers using Supabase and PostgreSQL. Contains performance rules across 8 categories, prioritized by impact from critical (query performance, connection management) to incremental (advanced features). Each rule includes detailed explanations, incorrect vs. correct SQL examples, query plan analysis, and specific performance metrics to guide automated optimization and code generation. Comprehensive Postgres performance optimization guide for developers using Supabase and Postgres. Contains performance rules across 8 categories, prioritized by impact from critical (query performance, connection management) to incremental (advanced features). Each rule includes detailed explanations, incorrect vs. correct SQL examples, query plan analysis, and specific performance metrics to guide automated optimization and code generation.
--- ---

View File

@@ -1,6 +1,7 @@
# Postgres Best Practices - Contributor Guide # Postgres Best Practices - Contributor Guide
This repository contains Postgres performance optimization rules optimized for AI agents and LLMs. This repository contains Postgres performance optimization rules optimized for
AI agents and LLMs.
## Quick Start ## Quick Start
@@ -67,7 +68,7 @@ packages/postgres-best-practices-build/
See `rules/_template.md` for the complete template. Key elements: See `rules/_template.md` for the complete template. Key elements:
```markdown ````markdown
--- ---
title: Clear, Action-Oriented Title title: Clear, Action-Oriented Title
impact: CRITICAL|HIGH|MEDIUM-HIGH|MEDIUM|LOW-MEDIUM|LOW impact: CRITICAL|HIGH|MEDIUM-HIGH|MEDIUM|LOW-MEDIUM|LOW
@@ -85,6 +86,7 @@ tags: relevant, keywords
-- Comment explaining what's wrong -- Comment explaining what's wrong
[Bad SQL example] [Bad SQL example]
``` ```
````
**Correct (description):** **Correct (description):**
@@ -93,11 +95,7 @@ tags: relevant, keywords
[Good SQL example] [Good SQL example]
``` ```
**Supabase Note:** [Optional platform-specific guidance]
Reference: [Link](url)
``` ```
## Writing Guidelines ## Writing Guidelines
See `rules/_contributing.md` for detailed guidelines. Key principles: See `rules/_contributing.md` for detailed guidelines. Key principles:
@@ -118,11 +116,4 @@ See `rules/_contributing.md` for detailed guidelines. Key principles:
| MEDIUM | 1.5-3x | Redundant indexes, stale statistics | | MEDIUM | 1.5-3x | Redundant indexes, stale statistics |
| LOW-MEDIUM | 1.2-2x | VACUUM tuning, config tweaks | | LOW-MEDIUM | 1.2-2x | VACUUM tuning, config tweaks |
| LOW | Incremental | Advanced patterns, edge cases | | LOW | Incremental | Advanced patterns, edge cases |
```
## Supabase-Specific Content
Keep ~90% of content as universal Postgres patterns. Add Supabase notes for:
- Supavisor connection pooling
- Dashboard features (index monitoring, query stats)
- RLS best practices with Supabase auth
- PostgREST considerations

View File

@@ -2,7 +2,7 @@
"version": "1.0.0", "version": "1.0.0",
"organization": "Supabase", "organization": "Supabase",
"date": "January 2026", "date": "January 2026",
"abstract": "Comprehensive Postgre performance optimization guide for developers using Supabase and Postgre. Contains performance rules across 8 categories, prioritized by impact from critical (query performance, connection management) to incremental (advanced features). Each rule includes detailed explanations, incorrect vs. correct SQL examples, query plan analysis, and specific performance metrics to guide automated optimization and code generation.", "abstract": "Comprehensive Postgres performance optimization guide for developers using Supabase and Postgres. Contains performance rules across 8 categories, prioritized by impact from critical (query performance, connection management) to incremental (advanced features). Each rule includes detailed explanations, incorrect vs. correct SQL examples, query plan analysis, and specific performance metrics to guide automated optimization and code generation.",
"references": [ "references": [
"https://www.postgresql.org/docs/current/", "https://www.postgresql.org/docs/current/",
"https://supabase.com/docs", "https://supabase.com/docs",