mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 03:09:50 +08:00
2320c50264
* ci: update package details and add GitHub workflows for skills validation and release * chore: update Node version, change license, and refactor skills validation script to TypeScript * chore: remove unused deps * fix: npm package * fix: flatten skills to pass validation * chore: add validation script to package.json and update GitHub workflow to use it * chore: enhance skills validation and update workflows for npm publishing * refactor: streamline skills validation process in workflow and script * refactor: improve documentation and structure of skills validation script * implement checks based on jeff's best practices doc * chore: add pull request template for skill submissions * chore: update pull request template with additional references and improve automated checks section * chore: update pull request template to clarify naming convention with a warning for gerund form * chore: update pull request template to reference skill authoring guide and enhance checklist structure * chore: enhance GitHub workflows for skills validation and release process * refactor: improve parsing logic for SKILL.md files and enhance error collection in validation * chore: update validation checks to enforce character limits for skill names and descriptions * fix: remove unnecessary whitespace in footer string in validate-skills.ts
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
**References:** [Contributing guide](../CONTRIBUTING.md) · [Skill authoring guide](../README.md) · [Agent Skills spec](https://agentskills.io/specification)
|
|
|
|
## What changed
|
|
|
|
<!-- Briefly describe what skill(s) were added, updated, or removed. -->
|
|
|
|
## Why
|
|
|
|
<!-- What gap does this fill, or what problem does it solve? -->
|
|
|
|
## Notes
|
|
|
|
<!-- Anything reviewers should know — testing approach, follow-ups, open questions. -->
|
|
|
|
---
|
|
|
|
## Skills
|
|
|
|
### Manual checklist
|
|
|
|
**Description quality**
|
|
- [ ] Describes what the skill does and the expected output
|
|
- [ ] Includes relevant Salesforce domain keywords (Apex, LWC, SOQL, metadata types, etc.)
|
|
- [ ] Trigger phrases are specific enough for Vibes to select this skill reliably
|
|
|
|
**Instructions**
|
|
- [ ] Clear goal statement
|
|
- [ ] Step-by-step workflow
|
|
- [ ] Validation rules for generated output
|
|
- [ ] Defined output / artifact
|
|
|
|
**Context efficiency**
|
|
- [ ] Core instructions are concise — supporting material lives in `templates/`, `examples/`, or `docs/` subdirectories
|
|
- [ ] No unnecessary background explanation in the body
|
|
|
|
### Automated checks
|
|
|
|
Enforced by CI ([`npm run validate:skills`](../scripts/validate-skills.ts)) per the [Agent Skills spec](https://agentskills.io/specification):
|
|
|
|
- Directory is one level deep, named in kebab-case (max 64 chars), contains `SKILL.md`
|
|
- Frontmatter `name` matches directory name; `description` is present, ≥ 20 words, ≤ 1024 characters, and includes trigger language
|
|
- Body is non-empty and under 500 lines
|
|
- Name uses gerund form ⚠ (warning — does not block merge)
|