Skip to content

Instantly share code, notes, and snippets.

@0xatm
0xatm / AGENTS.md
Created December 5, 2025 00:23 — forked from juanpabloaj/AGENTS.md
General guidelines and best practices for AI code generation

1. Core Coding Principles

  • Language: All code, comments, variable names, function names, class names, and commit messages must be strictly in English.
  • Idiomatic Style:
    • Write code that adheres to the idiomatic style, conventions, and official style guides of the target language. This includes formatting, naming, and general structure.
    • Assume a linter or formatter will eventually run; aim to produce code that is already close to passing common linting rules.
  • Clarity and Readability:
    • Prioritize clarity, readability, and maintainability over unnecessary "cleverness" or extreme brevity if it sacrifices understanding.
    • Write self-documenting code.
  • Follow the Principle of Least Surprise: code should behave in a way that users and other developers would naturally expect.