agentleFS
Sign inStart free
ansibleansible/vscode-ansible/AGENTS.md

vscode-ansible

AGENTS.md491 starsChanged 7 months agoMITView on GitHub

This document provides guidelines for AI agents working on this codebase. Do not use URLs; just the issue key (it will be auto-linked when rendered). - [ ] Quality: Commit messages should be informative, brief, and use correct grammar. Less is more—avoid boilerplate language. AI can help write better messages.

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Always validate changes: Run task lint and task test and resolve any reported build issues.

    line 9
  2. Very specific:

    Avoid __dirname: Do not use __dirname in new code.

    line 10
  3. Very specific:

    Always use npm exec -- instead of npx because it can cause accidental installation of unversioned packages from npmjs.com when this is not …

    line 11
  4. Distinctive:

    Do not use URLs; just the issue key (it will be auto-linked when rendered).

    line 25
  5. Very specific:

    Use appropriate formats: png, svg, webp, mp4 (avoid gif)

    line 49

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Instructions for AI Agents

This document provides guidelines for AI agents working on this codebase.

General Development Guidelines

Code Validation

  • Always validate changes: Run task lint and task test and resolve any reported build issues.
  • Avoid __dirname: Do not use __dirname in new code. It doesn't work well with transpiled code as relative paths differ when files are transpiled. Use PROJECT_ROOT from test/setup.ts instead.
  • Always use npm exec -- instead of npx because it can cause accidental installation of unversioned packages from npmjs.com when this is not desired, also they can prevent unattended usage occasionally.

Pull Request Checklist

Commit Messages

  • 50/72 rule: Commit title must be less than 50 characters; additional lines wrapped at 72 characters.
  • Conventional commits: PR title and description (from first commit) must follow conventional commits standard.

  • Issue references: Commit or PR body must include one plain text line referencing a GitHub issue and/or Jira issue using:

    (fixes|closes|related): #<issue_number|AAP-number>

    Do not use URLs; just the issue key (it will be auto-linked when rendered).

  • Quality: Commit messages should be informative, brief, and use correct grammar. Less is more—avoid boilerplate language. AI can help write better messages.

Pull Request Structure

  • Single commit: PR should contain a single commit. Squash changes and rebase before pushing new changes.
  • Atomic changes: If changes can be split into smaller atomic PRs, do so.
  • Draft status: Keep PR as draft until CI reports green on all jobs.

Testing & Build

  • All tests passing: All tests must pass. If a failure doesn't look related to your change, double-check. You may need a preparatory PR to fix the issue first.
  • Build artifacts: Ensure build jobs produce at least 3 artifacts matching these patterns:
    • logs*
    • ansible-language-server*.tgz
    • ansible-extension-build-*.zip

Documentation

  • Heading titles: Keep heading titles short so they render without wrapping in the sidebar.
  • Code blocks & diagrams: Ensure code blocks and diagrams render correctly in both dark and light mode.
  • Media files: Images and videos must:
    • Not be blurry
    • Be small in size
    • Use appropriate formats: png, svg, webp, mp4 (avoid gif)

Download now (ZIP)

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free