kris/afv-library
1
0
Fork 0
mirror of https://github.com/forcedotcom/afv-library.git synced 2026-08-07 16:04:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
d78f4c9b80
afv-library/.github/pull_request_template.md

1.5 KiB
Raw Blame History

References: Contributing guide · Repo structure

What changed

Why

Notes

Skills

References: Skill authoring guide · Automated checks

Checklist

Naming

  • Name uses gerund form — first word ends in -ing (e.g. generating-apex-tests)

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):

  • Directory is one level deep, named in kebab-case, contains SKILL.md
  • Frontmatter name matches directory name; description is present, ≥ 20 words, and includes trigger language
  • Body is non-empty and under 500 lines