DJANGO + POSTGRESQL AGENTS.MD

A Django project on PostgreSQL. Django is well represented in training data, but agents still skip migrations, write N+1 queries and leak settings; these files address each one.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The Django + PostgreSQL filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: django-project. A Django web application on PostgreSQL.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: Python
- Framework: Django
- Database: PostgreSQL
- Hosting: Render
- Tests: Django test runner
- Package manager: uv

## Commands

Run these from the repository root.

- Install dependencies: `uv sync`
- Run locally: `uv run python manage.py runserver`
- Build: `uv run python manage.py check --deploy`
- Run all tests: `uv run python manage.py test`
- Run one test file: `uv run python manage.py test app_name.tests.test_module`
- Lint: `uv run ruff check .`
- Type-check: `uv run mypy .`
- Format: `uv run ruff format .`

## Project layout

- `config/`: Project settings, root URLconf, WSGI and ASGI
- `apps/<name>/`: One Django app per domain area: models, views, urls, admin, tests
- `apps/<name>/migrations/`: Generated migrations (committed)
- `templates/`: Project-wide templates
- `static/`: Source static files

## Code style

- Indent with 4 spaces. Never tabs.
- Every new or changed Python function has type hints for its parameters and return value.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Prefer small pure functions and immutable data; keep side effects at the edges (handlers, jobs, I/O modules).
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Product constraints

- Validate all input at the boundary, use parameterized queries only, and treat every external payload as untrusted.

## Project-specific notes

- Every model change ships with its migration: run `uv run python manage.py makemigrations` and commit the generated file in the same change.
- Never edit a migration that has been applied anywhere except your own machine; add a new one instead.
- Avoid N+1 queries: use `select_related` for foreign keys and `prefetch_related` for reverse and many-to-many relations in list views.
- Read secrets and per-environment settings from environment variables; `DEBUG` is False and `SECRET_KEY` comes from the environment outside development.
- Use the ORM or parameterized `cursor.execute(sql, params)`; never format SQL strings with user input.
- Forms and serializers validate input; views do not read `request.POST` directly for model writes.
- Use `get_object_or_404` and check object permissions in views that load a record by id.

## Project phase

This project is in active development. Follow the patterns that already exist; consistency beats novelty.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: django-project. A Django web application on PostgreSQL.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: Python
- Framework: Django
- Database: PostgreSQL
- Hosting: Render
- Tests: Django test runner
- Package manager: uv

## Commands

- Install dependencies: `uv sync`
- Run locally: `uv run python manage.py runserver`
- Build: `uv run python manage.py check --deploy`
- Run all tests: `uv run python manage.py test`
- Run one test file: `uv run python manage.py test app_name.tests.test_module`
- Lint: `uv run ruff check .`
- Type-check: `uv run mypy .`
- Format: `uv run ruff format .`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the Django + PostgreSQL preset

What Is in the Django + PostgreSQL AGENTS.md?

The preset describes a a Django web application on PostgreSQL. Its AGENTS.md is 52 non-empty lines with 8 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: uv sync, uv run python manage.py runserver, uv run python manage.py check --deploy, uv run python manage.py test, uv run python manage.py test app_name.tests.test_module, uv run ruff check ., uv run mypy ., uv run ruff format ..
  • Layout: config/, apps/<name>/, apps/<name>/migrations/, templates/, static/.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for Django + PostgreSQL?

Missing migrations break the next deploy

An agent that adds a model field without running makemigrations produces code that passes some tests and then fails in production with a missing column. Making the migration part of the same change is the fix.

N+1 queries hide in templates

A loop over objects that touches obj.author.name fires one query per row. It is invisible in development with ten rows and slow in production with ten thousand.

Settings are a security surface

DEBUG on in production exposes stack traces and settings. A hard-coded SECRET_KEY lets anyone forge sessions. check --deploy flags both, which is why it is the build command here.

Object-level permissions

Loading a record by id from the URL without checking ownership is the most common access-control bug in Django apps.

Which Stack Rules Does the File Add?

  • Every model change ships with its migration: run uv run python manage.py makemigrations and commit the generated file in the same change.
  • Never edit a migration that has been applied anywhere except your own machine; add a new one instead.
  • Avoid N+1 queries: use select_related for foreign keys and prefetch_related for reverse and many-to-many relations in list views.
  • Read secrets and per-environment settings from environment variables; DEBUG is False and SECRET_KEY comes from the environment outside development.
  • Use the ORM or parameterized cursor.execute(sql, params); never format SQL strings with user input.
  • Forms and serializers validate input; views do not read request.POST directly for model writes.
  • Use get_object_or_404 and check object permissions in views that load a record by id.

How Do You Add These Files to a Django + PostgreSQL Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Which Similar Stacks Are in the Library?

All presets are on the stacks page.

Frequently Asked Questions

Does this template use pytest or the Django test runner?

The Django test runner, because it needs no extra packages. If you use pytest-django, choose pytest in the generator and replace the test commands.

Why uv for a Django project?

uv installs and resolves dependencies quickly and runs commands in the project environment with uv run. Choose pip or Poetry in the generator if that is what your project uses.

Can I use these rules with Django REST Framework?

Yes. Add a note about serializers, viewsets and your permission classes so the agent follows your API conventions.

Are these Django + PostgreSQL files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?