drawdb icon indicating copy to clipboard operation
drawdb copied to clipboard

Add AGENTS.md (comprehensive agent guide)

Open PeterDaveHello opened this issue 2 months ago • 1 comments

Mainly generated by codex-cli v0.42.0, with gpt-5-codex high, and this AGENTS.md construction prompt:

  • https://gist.github.com/PeterDaveHello/f30c38a156982a35683edfd5ece2d474

This guide captures the repository structure, tooling, and safety checks so contributors and coding agents can quickly grasp the project architecture, stay aligned, and deliver efficient, well-vetted changes with confidence.

Reference:

  • https://agents.md/

Summary from GitHub Copilot:

This pull request adds comprehensive repository guidelines to the project documentation. The new AGENTS.md file covers best practices for development, project structure, coding style, testing, commit conventions, safety, and architecture, providing clear instructions for contributors.

Repository and development workflow guidelines:

  • Added detailed dos and don’ts for contributing, including instructions on dependency management, linting, build requirements, and handling environment variables.
  • Documented the project structure, module organization, and build/test commands, clarifying the purpose of major directories and files, and how to run, lint, and build the app.

Coding standards and commit conventions:

  • Established coding style and naming conventions, including Prettier and ESLint rules, file naming, module path guidelines, and language requirements for comments and translations.
  • Provided guidelines for commit messages and pull requests, emphasizing focused diffs, imperative subject lines, referencing issues, and including behavioral explanations for UI changes.

Architecture and security:

  • Explained the app’s architecture, including state management, API interactions, export/import workflows, and the handling of templates and seed data.
  • Outlined safety, permissions, and security tips, such as restrictions on adding dependencies, handling secrets, and environment variable usage.

PeterDaveHello avatar Oct 02 '25 16:10 PeterDaveHello

@PeterDaveHello is attempting to deploy a commit to the dottle's projects Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Oct 02 '25 16:10 vercel[bot]