Skip to content

docs(create-agentsmd): prioritize concise, reusable agent context - #6155

Closed
imsergiobernal wants to merge 2 commits into
github:mainfrom
imsergiobernal:main
Closed

imsergiobernal wants to merge 2 commits into
github:mainfrom
imsergiobernal:main

Conversation

@imsergiobernal

Copy link
Copy Markdown

Description

The create-agentsmd skill previously encouraged comprehensive setup, style, testing, and deployment instructions inside AGENTS.md. This can load lengthy procedures into sessions that never need them and duplicate documentation that already exists.

Update the guidance and template to keep AGENTS.md as small as possible while preserving essential, actionable context. Every token should help the agent make decisions across sessions; task-specific detail should be available through precise references when needed.

  • Keep short command lists and concise rules inline, including test/build commands, PR title formats, and required checks. Existing command blocks can also be linked.
  • Put extended setup, dependencies, configuration, troubleshooting, and deployment procedures in human documentation or dedicated skills, linking to coherent line ranges.
  • Preserve the four code-style topics as individual links to their relevant external content.
  • Allow related guidance to share a reference rather than mechanically requiring a link for every rule.
  • Require example paths and line ranges to be replaced with verified project references and maintained when content moves.
  • Remove the additional working example to avoid repeating the template.

This balances minimal persistent context with enough direction to find detailed guidance. CONTRIBUTING.md and README.md paths in the template are illustrative; the references must be adapted to the repository.

Validation

  • npm run skill:validate passed for all 448 skills.
  • npm run build passed; generated documentation remains unchanged. It reported existing SPDX identifier warnings for external plugins.
  • bash eng/fix-line-endings.sh completed.
  • git diff --cached --check passed before committing.

The revised instructions have not been tested in a GitHub Copilot session.

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines applicable to this update.
  • I have read and followed the guidance for submissions involving paid services (not applicable).
  • My contribution adds a new resource (this updates an existing skill).
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested the revised skill with GitHub Copilot.
  • I have run the build and verified that README.md is up to date.
  • I am targeting the main branch.

Type of Contribution

  • Update to an existing skill.

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

@imsergiobernal
imsergiobernal requested a review from a team as a code owner November 1, 2026 15:13
@github-actions github-actions Bot added the skills PR touches skills label Nov 1, 2026
@github-actions

github-actions Bot commented Nov 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 commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

🚦 Submission status: 👀 Ready for review

Risk tier: merge-risk:medium — New or substantially changed resource without privileged execution
Required to merge: passing submission-gate checks plus 1 approval from reviewers with write access.

Why this tier
  • Changes 125 lines (low-risk limit is 40)

Automated checks

Check Status Details
Line endings ✅ Passed Passed · logs
Spelling ✅ Passed Passed · logs
Generated README consistency ✅ Passed Passed · logs
Skill validation ✅ Passed Passed · logs
Skill lint (vally) ✅ Passed Passed · logs
Risk scan ✅ Passed Passed · logs
Contributor reputation ✅ Passed Passed · logs
Duplicate resource scan ✅ Passed Passed · logs
PR quality signal ⏭️ Skipped Skipped by its workflow · logs

Review

  • Approvals: 0/1
  • Assigned reviewer: not assigned yet — comment /request-review to ask for one
  • Review target date: not set
  • Still needed: 1 more approval(s)
  • No staffed reviewer pool owns these files yet; any reviewer with write access counts as the domain reviewer.

Commands

Command Who What it does
/rerun-checks PR author, maintainers Re-runs failed or incomplete checks and re-evaluates this gate
/request-review PR author, maintainers Asks the review rotation to assign a reviewer (adds needs-reviewer)

Updated for 8b61fac · gate run · This comment is maintained automatically — see submission gate docs.

@github-actions github-actions Bot added the skill-check-error Skill validator reported errors label Nov 1, 2026
@github-actions

github-actions Bot commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

🔍 Vally Lint Results

⛔ Findings need attention

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

Summary

Level Finding
❌ create-agentsmd (1/2 checks passed, 1 failed)
Full linter output
### Linting skills/create-agentsmd
❌ create-agentsmd (1/2 checks passed, 1 failed)
    ✓ [spec-compliance] All 1 skill(s) are spec-compliant.
        ✓ spec-compliance: All spec checks passed.
    ✗ [valid-refs] 1 of 1 skill(s) have invalid file references.
        ✗ valid-refs: Found 1 invalid file reference(s): README.md (missing).

1 skill(s) linted, 1 failed

Note: Vally lint returned a non-zero exit code. Please review the findings above before merge.

@github-actions github-actions Bot added ready-for-review Submission passed intake validation and is ready for maintainer review and removed awaiting-automation labels Nov 1, 2026
@github-actions github-actions Bot added awaiting-automation ready-for-review Submission passed intake validation and is ready for maintainer review and removed ready-for-review Submission passed intake validation and is ready for maintainer review awaiting-automation labels Nov 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge-risk:medium ready-for-review Submission passed intake validation and is ready for maintainer review skill-check-error Skill validator reported errors skills PR touches skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant