crafting-effective-readmes
Pass
Audited by Gen Agent Trust Hub on Sep 21, 2026
Risk Level: SAFENO_CODE
Full Analysis
- [NO_CODE]: The skill consists entirely of Markdown files providing templates and stylistic guidance. No executable scripts, binaries, or automation tools are included in the package.\n- [SAFE]: The skill instructions define a purely conversational and text-based workflow. The agent is guided to ask questions and read project metadata (such as package.json) to generate text recommendations, which carries no execution risk.\n- [CREDENTIALS_SAFE]: The provided template for internal projects (
templates/internal.md) utilizes placeholders for sensitive information like API keys and database URLs, and it explicitly recommends using secure secret management tools (e.g., Vault, 1Password) for handling actual credentials.\n- [EXTERNAL_DOWNLOADS]: The skill references several well-known community resources and documentation standards (e.g., Standard Readme, Shields.io). These references are documented as educational material and do not involve the downloading or execution of untrusted code.
Audit Metadata