Files
endorsment/.github/skills/example-skill/SKILL.md

1.6 KiB

name, description, license
name description license
example-skill Example skill template demonstrating the structure and format of a GitHub Copilot agent skill. Use this as a reference when creating new skills. MIT

Example Skill Template

This is an example skill that demonstrates the proper structure for creating GitHub Copilot agent skills.

When to use this skill

Describe when Copilot should use this skill. Be specific about:

  • The types of tasks this skill addresses
  • Keywords or phrases that should trigger this skill
  • Context in which this skill is most helpful

Instructions

Provide clear, step-by-step instructions for Copilot to follow:

  1. First Step: Describe the first action to take

    • Include any specific tools or commands to use
    • Mention any prerequisites or checks to perform
  2. Second Step: Describe the next action

    • Provide examples where helpful
    • Include error handling guidance
  3. Third Step: Continue with additional steps

    • Be as detailed as necessary
    • Include best practices and common pitfalls to avoid

Examples

Example 1: Basic Usage

Provide code examples or command examples that demonstrate
how to use this skill effectively.

Example 2: Advanced Usage

Include more complex examples if needed to illustrate
advanced scenarios or edge cases.

Additional Resources

  • Reference any relevant documentation
  • Link to related tools or scripts in this skill directory
  • Mention any dependencies or requirements

Notes

  • Include any important warnings or considerations
  • Document known limitations
  • Add troubleshooting tips if applicable