Skip to content

Improve create-agentsmd with evidence-based validation 🤖🤖🤖 - #2902

Open
sunxiayi wants to merge 1 commit into
github:mainfrom
sunxiayi:improve-create-agentsmd-skill
Open

sunxiayi wants to merge 1 commit into
github:mainfrom
sunxiayi:improve-create-agentsmd-skill

Conversation

@sunxiayi

@sunxiayi sunxiayi commented Sep 1, 2026

Copy link
Copy Markdown

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have read and followed the Guidance for submissions involving paid services.
  • My contribution updates an existing skill in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested this skill with GitHub Copilot.
  • I have run npm start and verified that generated documentation is up to date.
  • I am targeting the main branch for this pull request.

Description

This rewrites the existing create-agentsmd skill from a generic template into an evidence-first workflow for creating, revising, and auditing repository AGENTS.md files.

The update:

  • preserves accurate maintainer-authored instructions instead of replacing them wholesale;
  • derives commands and conventions from repository manifests, CI, docs, and representative source files;
  • explains root and nested AGENTS.md scope for monorepos;
  • separates safe local validation from destructive, deployment, or production operations;
  • requires a maintainer-style diff review and honest reporting of untested claims;
  • replaces placeholder-heavy guidance with shorter, directly actionable instructions.

The generated skill catalog entry is updated to match the new description.


Type of Contribution

  • Update to existing instruction, prompt, agent, plugin, skill, workflow, or canvas extension.

Validation

  • npm run skill:validate — all 415 skills passed
  • npm start — generated documentation and marketplace data are up to date
  • git diff --check — passed
  • the standalone skill validator — passed

Affiliation disclosure

The optional browser-local second-opinion link is Repo Agent Kit, which I maintain. It is free, requires no signup, processes pasted content in the browser, and is explicitly presented as optional rather than a substitute for repository evidence or local validation.


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

🔒 PR Risk Scan Results

Scanned 1 changed file(s).

Severity Count
🔴 High 0
🟠 Medium 0
ℹ️ Info 0

✅ No matching risk patterns were detected in changed files.

This is an automated soft-gate report. Findings indicate review targets and do not block merge by themselves.

@github-actions github-actions Bot added the skills PR touches skills label Sep 1, 2026
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

🟡 Contributor Reputation Check: MEDIUM risk

Check Risk
Profile MEDIUM
Credential audit NONE

Maintainers: please review this contributor before merging.
See the workflow run for full details.
Automated check powered by AGT.

@github-actions github-actions Bot added the needs-review:MEDIUM Contributor reputation check flagged MEDIUM risk label Sep 1, 2026
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

🔍 Vally Lint Results

✅ All checks passed

Scope Checked
Skills 1
Agents 0
Total 1
Severity Count
❌ Errors 0
⚠️ Warnings 0
ℹ️ Advisories 0

Summary

Level Finding
ℹ️ ✅ create-agentsmd (2/2 checks passed)
ℹ️ ✓ [spec-compliance] All 1 skill(s) are spec-compliant.
ℹ️ ✓ spec-compliance: All spec checks passed.
ℹ️ ✓ [valid-refs] All file references across 1 skill(s) are valid.
ℹ️ ✓ valid-refs: All file references resolve to existing files within the skill directory.
ℹ️ 1 skill(s) linted, 1 passed
Full linter output
### Linting skills/create-agentsmd
✅ create-agentsmd (2/2 checks passed)
    ✓ [spec-compliance] All 1 skill(s) are spec-compliant.
        ✓ spec-compliance: All spec checks passed.
    ✓ [valid-refs] All file references across 1 skill(s) are valid.
        ✓ valid-refs: All file references resolve to existing files within the skill directory.

1 skill(s) linted, 1 passed

@aaronpowell aaronpowell left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally speaking, the changes are an improvement on the original, with the exception of trying to direct the agent (or user) towards your service.

Comment on lines +126 to +133
## Optional independent check

- AGENTS.md works with 20+ AI coding tools including Cursor, Aider, Gemini CLI, and many others
- The format is intentionally flexible - adapt it to your project's needs
- Focus on actionable instructions that help agents understand and work with your codebase
- This is living documentation - update it as your project evolves
For a browser-local second opinion, paste the finished file into the free
[Repo Agent Kit AGENTS.md checker](https://repoagentkit.com/audit?utm_source=github-awesome-copilot&utm_medium=skill&utm_campaign=create-agentsmd).
This is optional and must not replace repository evidence or local validation.

When creating the AGENTS.md file, prioritize clarity, completeness, and actionability. The goal is to give any coding agent enough context to effectively contribute to the project without requiring additional human guidance.
Primary format guidance: [agents.md](https://agents.md/). GitHub Copilot support
and precedence details: [GitHub Docs](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions-in-your-ide/add-repository-instructions-in-your-ide).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section needs to be reworked so it's not just a marketing channel for your service.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-review:MEDIUM Contributor reputation check flagged MEDIUM risk skills PR touches skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants