Initial shared Copilot resources scaffold
This commit is contained in:
58
README.md
Normal file
58
README.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# Copilot Resources
|
||||
|
||||
Copilot Resources is a shared, Git-backed home for prompts, skills, agents,
|
||||
instructions, hooks, scripts, and templates that should follow you across
|
||||
machines and across VS Code and Copilot CLI sessions.
|
||||
|
||||
## Goals
|
||||
|
||||
- Keep one canonical source of truth for shared Copilot assets.
|
||||
- Make new resources easy to create, publish, and propagate.
|
||||
- Minimize per-machine setup after the first bootstrap.
|
||||
- Support macOS, Linux, and Windows.
|
||||
|
||||
## Current Foundation
|
||||
|
||||
This initial implementation provides:
|
||||
|
||||
- A stable install model based on `~/.copilot-resources`
|
||||
- Bootstrap scripts for macOS/Linux and Windows
|
||||
- Publish, update, and verify scripts
|
||||
- Scripted VS Code settings merge for managed Copilot-related keys
|
||||
- Scripted Copilot CLI environment wiring through a managed sourced fragment
|
||||
|
||||
## Operating Model
|
||||
|
||||
There are two supported ways to add shared assets:
|
||||
|
||||
- Repo-first: create the resource directly in this repository.
|
||||
- Local-first: create the resource in a normal workspace or user profile, then
|
||||
publish it into this repository with the publish script.
|
||||
|
||||
Once a resource lands in this repository, the repository becomes authoritative.
|
||||
Git push and pull plus scheduled sync spread the change to other systems.
|
||||
|
||||
## Bootstrap
|
||||
|
||||
Run one of these from the repository root:
|
||||
|
||||
```bash
|
||||
install/bootstrap.sh
|
||||
```
|
||||
|
||||
```powershell
|
||||
install/bootstrap.ps1
|
||||
```
|
||||
|
||||
The bootstrap scripts create a stable canonical path and connect default
|
||||
discovery locations back to this repository. For most surfaces, that means
|
||||
symlinks or junctions into default VS Code and Copilot paths rather than
|
||||
per-machine copies. They also merge the managed VS Code settings keys and add a
|
||||
small managed shell or PowerShell profile block for Copilot CLI environment
|
||||
variables without replacing the rest of the user config.
|
||||
|
||||
## Next Docs
|
||||
|
||||
The rest of the handbook will live in `docs/` and will cover architecture,
|
||||
authoring, publishing, governance, versioning, review standards, and
|
||||
troubleshooting.
|
||||
Reference in New Issue
Block a user