Skip to content

Commit 6268166

Browse files
committed
docs(readme): update documentation to reflect Agent Skills structure
- Add separate sections for Agent Skills and Custom Instructions - Document dynamic loading benefits (~70% token reduction) - Update project structure to include skills, instructions, and prompts - Add links to all Agent Skills with descriptions - Clarify distinction between dynamic skills and always-active instructions - Include references to skills README and migration guide
1 parent bc9047b commit 6268166

1 file changed

Lines changed: 53 additions & 26 deletions

File tree

README.md

Lines changed: 53 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Use this starter to define, manage, and share custom instructions and prompts fo
1515
- [Features](#features)
1616
- [Project Structure](#project-structure)
1717
- [Getting Started](#getting-started)
18-
- [Custom Instructions & Guidelines](#custom-instructions--guidelines)
18+
- [Agent Skills (Dynamic Loading)](#agent-skills-dynamic-loading)
19+
- [Custom Instructions (Always Active)](#custom-instructions-always-active)
1920
- [Custom Prompts](#custom-prompts)
2021
- [Specification-Driven Workflow Prompt (Optional)](#specification-driven-workflow-prompt-optional)
2122
- [Contributing](#contributing)
@@ -28,13 +29,17 @@ GitHub Copilot Starter is a template repository for configuring, customizing, an
2829

2930
## Features
3031

32+
- **Agent Skills**: Modular, dynamically-loaded skills following the [Agent Skills specification](https://agentskills.io/specification) for ~70% reduction in baseline token usage
33+
- **Custom instructions**: Universal principles (security, accessibility, best practices) that apply to all code
3134
- **Flexible instruction system**: Easily add, edit, or remove instruction files for coding standards, workflows, UI guidelines, accessibility, testing, and more
3235
- **Customizable prompts**: Define your own Copilot prompts and conventions for your team or project
3336
- **Best practices templates**: Includes example instructions for SOLID, DRY, KISS, commit messages, accessibility, and more
3437
- **Specification-driven workflow**: Optionally use the included workflow for requirements, design, implementation, and validation
3538
- **No fixed tech stack**: Adapt to any language, framework, or toolchain
3639

37-
## Project Structure
40+
## Project Stskills/` — Agent Skills (dynamically loaded when relevant)
41+
- `.github/instructions/` — Custom instructions (always active, universal principles)
42+
- `.github/prompts/` — Custom prompts for specific workflows
3843

3944
- `.github/instructions/` — Core instruction files (edit or add your own)
4045
- `/src`, `/tests`, `/public`, `/config`, `/docs` — Example folders for typical projects (customize or remove as needed)
@@ -44,32 +49,54 @@ GitHub Copilot Starter is a template repository for configuring, customizing, an
4449
1. **Clone the repository**
4550
```zsh
4651
git clone https://github.com/devbyrayray/github-copilot-starter.git
47-
cd github-copilot-starter
48-
```
49-
2. **Review and customize instruction files**
50-
- Edit files in `.github/instructions/` to match your team's standards and workflow
51-
- Add new instruction files for additional rules or prompts
52+
cd github-copilot-starskills and instructions**
53+
- Browse Agent Skills in `.github/skills/` for language/framework-specific standards
54+
- Edit custom instructions in `.github/instructions/` for universal principles
55+
- Customize prompts in `.github/prompts/` for specific workflows
5256
3. **Integrate with your project**
53-
- Copy or merge the instructions into your own repository
57+
- Copy or merge the skills, instructions, and prompts into your own repository
5458
- Adjust folder structure as needed for your tech stack
55-
56-
## Custom Instructions & Guidelines
57-
58-
- All coding standards, workflows, and conventions are defined in `.github/instructions/`
59-
- Example instructions provided for:
60-
- Coding standards ([coding.instructions.md](.github/instructions/coding.instructions.md))
61-
- Accessibility ([accessibility.instructions.md](.github/instructions/accessibility.instructions.md))
62-
- CSS ([css.instructions.md](.github/instructions/css.instructions.md))
63-
- Tailwind CSS ([tailwind.instructions.md](.github/instructions/tailwind.instructions.md))
64-
- HTML ([html.instructions.md](.github/instructions/html.instructions.md))
65-
- UI guidelines ([ui-guidelines.instructions.md](.github/instructions/ui-guidelines.instructions.md))
66-
- Commit messages ([commit.instructions.md](.github/instructions/commit.instructions.md))
67-
- Best practices ([best-practices.instructions.md](.github/instructions/best-practices.instructions.md))
68-
- Configuration files ([config.instructions.md](.github/instructions/config.instructions.md))
69-
- C# standards ([csharp.instructions.md](.github/instructions/csharp.instructions.md))
70-
- .NET standards ([dotnet.instructions.md](.github/instructions/dotnet.instructions.md))
71-
- JavaScript/TypeScript standards ([javascript-typescript.instructions.md](.github/instructions/javascript-typescript.instructions.md))
72-
- Vue standards ([vue.instructions.md](.github/instructions/vue.instructions.md))
59+
4. Agent Skills (Dynamic Loading)
60+
61+
Agent Skills are modular, discoverable instructions that AI agents load dynamically based on the task at hand. Skills are located in `.github/skills/` and follow the [Agent Skills specification](https://agentskills.io/specification).
62+
63+
**Language & Framework Standards:**
64+
- [JavaScript/TypeScript Standards](.github/skills/javascript-typescript-standards/) - ES2022, Node.js, async/await patterns
65+
- [Vue.js Development](.github/skills/vue-development/) - Vue 3 Composition API, SFC patterns
66+
- [Nuxt.js Development](.github/skills/nuxt-development/) - Nuxt 3, SSR/SSG, file-based routing
67+
- [CSS Standards](.github/skills/css-standards/) - CSS organization, selectors, responsive design
68+
- [Tailwind CSS](.github/skills/tailwind-css/) - Tailwind v4+, @theme directive, utility classes
69+
- [HTML Standards](.github/skills/html-standards/) - Semantic markup, accessibility, security
70+
- [C# Standards](.github/skills/csharp-standards/) - C# naming conventions, modern features
71+
- [.NET Development](.github/skills/dotnet-development/) - .NET architecture, dependency injection
72+
- [Markdown Standards](.github/skills/markdown-standards/) - Documentation formatting, validation
73+
74+
**Workflow Skills:**
75+
- [Testing & TDD](.github/skills/testing-tdd/) - TDD methodology, Vitest, xUnit
76+
- [Commit Conventions](.github/skills/commit-conventions/) - Conventional Commits + validation script
77+
78+
**Benefits:**
79+
- 🚀 ~70% reduction in baseline token usage
80+
- 📦 Progressive disclosure (metadata → instructions → resources)
81+
- 🔍 Better discovery through rich descriptions
82+
- 🛠️ Support for executable scripts (e.g., commit validation)
83+
84+
[📖 Learn more about Agent Skills](.github/skills/README.md)
85+
86+
## Custom Instructions (Always Active)
87+
88+
Universal principles and guidelines that apply to all code are located in `.github/instructions/`:
89+
90+
- [Coding Standards](.github/instructions/coding.instructions.md) - General coding conventions
91+
- [Best Practices](.github/instructions/best-practices.instructions.md) - SOLID, DRY, KISS principles
92+
- [Security](.github/instructions/security.instructions.md) - OWASP Top 10 security patterns
93+
- [Accessibility](.github/instructions/accessibility.instructions.md) - Universal accessibility guidelines
94+
- [UI Guidelines](.github/instructions/ui-guidelines.instructions.md) - Design principles
95+
- [Configuration](.github/instructions/config.instructions.md) - Configuration file standards
96+
- [Project Structure](.github/instructions/project-file-structure.instructions.md) - Repository organization
97+
- [Tooling](.github/instructions/tools.instructions.md) - Development tools and workflows
98+
99+
These instructions remain as custom instructions because they contain universal architecture patterns that should always be considered.
73100
- Nuxt.js standards ([nuxt.instructions.md](.github/instructions/nuxt.instructions.md))
74101
- Markdown standards ([markdown.instructions.md](.github/instructions/markdown.instructions.md))
75102
- Project structure ([project-file-structure.instructions.md](.github/instructions/project-file-structure.instructions.md))

0 commit comments

Comments
 (0)