Skip to content

AGENTS.md

Latest commit

 

History

History
31 lines (25 loc) · 1.13 KB

AGENTS.md

File metadata and controls

31 lines (25 loc) · 1.13 KB

Agent Guidelines

Commit & Git Conventions

When completing tasks and committing changes, follow these strict rules to format your commit descriptions:

  1. Enforce the Imperative Mood and Brevity:

    • Start the subject line with an imperative verb (e.g., fix, add, remove, refactor).
    • Keep the subject line under 72 characters.
    • Never use robotic preambles like "This commit modifies..." or "Successfully updated...".

  2. Focus on the "Why" Instead of the "What":

    • Explain the motivation behind the change. Why was the fix/feature necessary? What problem does it solve?

  3. Developer-Friendly Structure:

    • Use a short summary paragraph first, followed by bullet points for technical details.
    • Keep the tone professional, concise, and clear.

Reference Commit Style

Below are examples of commit messages written by the developer. Analyze these examples to understand and imitate the preferred writing style, tone, level of detail, and formatting:

fixed misspelled readme
---
docs: add AGENTS.md for AI coding assistants
---
Initial commit
---
streamlining install function
---
Update README.md