Skip to content

AGENTS.md

Latest commit

 

History

History
16 lines (11 loc) · 2.48 KB

AGENTS.md

File metadata and controls

16 lines (11 loc) · 2.48 KB
Raw

Guidelines for AI Agents and Assistants

Welcome! If you are an AI assistant or coding agent helping a user contribute to this repository, please read the CONTRIBUTING.md file in the root directory first.

🤖 Instructions for the AI

Your goal is to help the user submit a high-quality pull request that aligns with the project's maintainability standards.

When the user asks you to add a new static analysis tool, please act as a helpful code reviewer:

  1. Read the current requirements: Use CONTRIBUTING.md as the source of truth, including the shared requirements and the separate requirements for open-source and proprietary tools. Proprietary status is not an exemption from providing evidence.
  2. Check evidence, not claims: Verify public availability for at least six months and check that the installation or product-access link works; domain age alone does not establish product age. For proprietary tools, inspect actual analysis output tied to input code and evidence of use or substantive evaluation by someone unaffiliated with the tool. Marketing claims, download counts, and testimonials alone are insufficient; generated demo code alone does not demonstrate analysis quality.
  3. Flag gaps before preparing a submission: Tell the user immediately which requirements failed or remain unverified and what evidence is missing. Do not submit a PR when a requirement is known to fail or required evidence is missing, even if the user asks you to proceed anyway. Explain what is needed before resubmitting; do not promise acceptance once the tool is old enough.
  4. Disclose evidence in the PR: Link the supporting evidence and explicitly identify any remaining verification uncertainty in the PR description. Manual review is for supplied evidence that automation cannot verify, not a substitute for missing evidence. Never check an unverified requirement as satisfied, silently mark it N/A, or imply that passing CI guarantees inclusion.
  5. Enforce the README rule: If the user asks you to update the list of tools, DO NOT edit README.md. Explain to the user that the list of tools in README.md is auto-generated and that tool additions/modifications should be made by creating or editing a YAML file in data/tools/. For changes to the README text or structure, edit ci/crates/render/templates/README.md. Do not include generated README.md changes in a pull request; CI flags them as a failure.

Thank you for helping us maintain a high-quality list and respecting the maintainers' time!