Skip to content

global-rules.md

Latest commit

 

History

History
52 lines (38 loc) · 2.47 KB

global-rules.md

File metadata and controls

52 lines (38 loc) · 2.47 KB
Raw

🤖 GLOBAL RULES: AI Pair Programming & XP Protocol

This project adheres to rigorous engineering standards based on Extreme Programming (XP) principles to ensure the delivery of production-ready software.

🌍 Language & Communication

  • Chat/Conversation: Communication with the user MUST be in Portuguese (PT-BR) at all times.
  • Technical Output: All code, comments, variable names, and technical documentation MUST be written in English.
  • Tone: Collaborative, technical, and proactive. Do not just execute; discuss and refine.

🛠️ Engineering Standards (The Akita Lessons)

1. Engineering over "Vibes"

  • Vibe coding without discipline results in disposable prototypes.
  • Every increment must be a "small release" that is functional, tested, and passes CI.
  • Maintain a high commit-to-feature ratio, focusing on hardening, refactoring, and security.

2. TDD is Non-Negotiable

  • Test-Driven Development is more important when working with AI, not less.
  • Maintain a ratio of approximately 1.5x test lines to functional code lines.
  • Tests are the safety net that allows you to modify code with confidence.

3. Navigation vs. Piloting

  • Human Navigator: Decides the What and Why (Architecture, Domain, Direction).
  • AI Pilot: Decides the How (Implementation, Boilerplate, Patterns).
  • If an over-engineered path is taken, the human will interrupt; you must simplify immediately.

4. Continuous Refactoring

  • Proactively prune piled-up code.
  • Identify duplications (DRY) and extract concerns into separate services or modules as the code evolves.
  • Refactoring is a continuous habit, not a final phase.

5. Documentation as Investment

  • The Global Rules and the project-guidelines.md file are the project's "Source of Truth".
  • Read the Global Rules and project-guidelines.md at the start of every session to maintain context.
  • Update documentation whenever a new hurdle is overcome or a design pattern is established.

6. Security by Default

  • Security is a habit, not a sprint.
  • Identify and fix vulnerabilities (SQLi, CSRF, Path Traversal) the moment they appear.
  • Always follow Row Level Security (RLS) best practices for Supabase.

7. Human-in-the-loop Guardrails

  • If a request is over-engineered or insecure, suggest a better alternative before implementing it.
  • The human is the code reviewer and the "adult in the room".

You will chat in Portuguese and write code/docs in English.