proxysql

Commit Graph

Author	SHA1	Message	Date
René Cannaò	586fb734f8	Move git workflow to top of task template — agents skip buried instructions Learned from agent post-mortem: agents prioritize technical content over administrative instructions. Even when branch info is present, agents skim past it while focusing on code requirements, then use heuristics to fill the gap they don't realize they have. Fix: git workflow is now the FIRST section with "do this before reading anything else" label. Also updates common-mistakes.md with the expanded root cause analysis.	3 months ago
René Cannaò	c54e6e1805	Expand task assignment template with learnings from CodeRabbit plans Adds four new checklist items based on analyzing CodeRabbit's auto- generated plans for issues #5491 and #5492: - #9: Write ready-made prompts for executing agents — pre-digest the task into imperative, sequential, agent-optimized format - #10: Document design decisions with rationale — prevent agents from re-litigating settled architecture choices - #11: Show the research — make codebase analysis visible for verification and context transfer - #12: For refactoring tasks, specify what to replace — exact line ranges, replacement calls, include dependencies Also adds two new entries to the common mistakes table: - "Recreates existing infrastructure" (research contradicts plan) - "Uses wrong infrastructure" (multiple similar patterns exist) Updates the good-vs-bad example to demonstrate the new items.	3 months ago
René Cannaò	bf250c6307	Add agent guidelines documentation Adds doc/agents/ with three guidance documents for AI coding agents, based on lessons learned from Milestone 2-3 unit testing work: - project-conventions.md: ProxySQL-specific rules — directory layout, build system, unit test harness usage, header conventions, circular include dependency warnings, git workflow, dual-protocol coverage - task-assignment-template.md: Generic template and orchestrator checklist for writing GitHub issues that agents can execute correctly. Covers: specifying WHERE/HOW/environment, DO NOT lists, binary acceptance criteria, and the good-vs-bad issue example - common-mistakes.md: Catalog of 9 observed failure patterns with root cause analysis, prevention strategies, and shell commands for detection in agent PRs Also updates CLAUDE.md with a reference to the agent guidelines and a note about the unit test harness.	3 months ago

Author

SHA1

Message

Date

René Cannaò

586fb734f8

Move git workflow to top of task template — agents skip buried instructions

Learned from agent post-mortem: agents prioritize technical content over
administrative instructions. Even when branch info is present, agents skim
past it while focusing on code requirements, then use heuristics to fill
the gap they don't realize they have.

Fix: git workflow is now the FIRST section with "do this before reading
anything else" label. Also updates common-mistakes.md with the expanded
root cause analysis.

René Cannaò

c54e6e1805

Expand task assignment template with learnings from CodeRabbit plans

Adds four new checklist items based on analyzing CodeRabbit's auto-
generated plans for issues #5491 and #5492:

- #9: Write ready-made prompts for executing agents — pre-digest the
  task into imperative, sequential, agent-optimized format
- #10: Document design decisions with rationale — prevent agents from
  re-litigating settled architecture choices
- #11: Show the research — make codebase analysis visible for
  verification and context transfer
- #12: For refactoring tasks, specify what to replace — exact line
  ranges, replacement calls, include dependencies

Also adds two new entries to the common mistakes table:
- "Recreates existing infrastructure" (research contradicts plan)
- "Uses wrong infrastructure" (multiple similar patterns exist)

Updates the good-vs-bad example to demonstrate the new items.

René Cannaò

bf250c6307

Add agent guidelines documentation

Adds doc/agents/ with three guidance documents for AI coding agents,
based on lessons learned from Milestone 2-3 unit testing work:

- project-conventions.md: ProxySQL-specific rules — directory layout,
  build system, unit test harness usage, header conventions, circular
  include dependency warnings, git workflow, dual-protocol coverage

- task-assignment-template.md: Generic template and orchestrator
  checklist for writing GitHub issues that agents can execute correctly.
  Covers: specifying WHERE/HOW/environment, DO NOT lists, binary
  acceptance criteria, and the good-vs-bad issue example

- common-mistakes.md: Catalog of 9 observed failure patterns with
  root cause analysis, prevention strategies, and shell commands for
  detection in agent PRs

Also updates CLAUDE.md with a reference to the agent guidelines and
a note about the unit test harness.

3 Commits (6cdd4e697eb86982e3dfd2ceab009ead5da0efcb)