Skip to content

feat: add Context Files (skills/, AGENTS.md polish) — closes #60#90

Open
VishalGawade1 wants to merge 2 commits into
microsoft:mainfrom
VishalGawade1:feat/context-files-issue-60
Open

feat: add Context Files (skills/, AGENTS.md polish) — closes #60#90
VishalGawade1 wants to merge 2 commits into
microsoft:mainfrom
VishalGawade1:feat/context-files-issue-60

Conversation

@VishalGawade1
Copy link
Copy Markdown

Summary

Resolves #60. Establishes the repo's "Context Files" surface for AI agents.

  • skills/ — repo-specific instructions for the two recurring tasks called out in the issue:
  • Symlinks so popular harnesses auto-discover skills without duplicating content:
    • .claude/skills/*.md → Claude Code
    • .github/instructions/*.md → Copilot / awesome-copilot
  • AGENTS.md rewritten and polished against the GitHub blog rubric:
    • Replaces broken Hugo-style /improve/... links with repo-relative paths that resolve on GitHub.
    • YAML frontmatter, explicit persona, repo map, build/test commands, rule + skill authoring pointers, local trust flow.
    • Tech stack with pinned versions (Node, TS, vitest, Playwright, esbuild, eslint, VS Code engine).
    • Code style with a good-vs-bad TypeScript snippet.
    • Git workflow (branch naming, Conventional Commits, pre-push checks).
    • Three-tier boundaries: ✅ Always / ⚠️ Ask first / 🚫 Never — with explicit never-commit-secrets and never-edit-generated-artifacts lists.

Markdown-only change. No runtime/build code touched.

Test plan

  • npm run spellcheck passes
  • All AGENTS.md repo-relative links resolve in GitHub's preview
  • skills/ symlinks resolve to the same content under .claude/skills/ and .github/instructions/
  • Reviewer sanity-check: skills are scoped to one task each, not a generalist dumping ground
  • Reviewer sanity-check: boundaries reflect actual repo conventions (no telemetry, read-only user data, bundle-size budget)

VishalGW added 2 commits June 1, 2026 11:42
Resolves microsoft#60.

- Add skills/ with two repo-specific instruction files for the recurring
  tasks called out in the issue: update-docs and package-extension.
- Rewrite AGENTS.md: replace Hugo-style /improve/... links (broken on
  GitHub) with repo-relative paths, add a repo map, build/test commands,
  pointers to rule and skill authoring, and the local trust flow.
- Symlink skills into .claude/skills/ (Claude Code) and
  .github/instructions/ (Copilot / awesome-copilot) so popular harnesses
  auto-discover them without duplicating content.

Markdown-only change; npm run spellcheck passes.
Apply the "great AGENTS.md" guidance from
https://github.blog/ai-and-ml/github-copilot/how-to-write-a-great-agents-md-lessons-from-over-2500-repositories/:

- YAML frontmatter (name, description) and explicit persona.
- Tech stack with pinned versions (Node, TS, vitest, Playwright, esbuild,
  eslint, VS Code engine).
- Code style section with a good-vs-bad TypeScript snippet.
- Git workflow: branch naming, Conventional Commits, pre-push checks.
- Three-tier boundaries (Always / Ask first / Never), including explicit
  never-commit-secrets and never-edit-generated-artifacts lists.

Markdown-only; npm run spellcheck passes.
@VishalGawade1
Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Context Files

2 participants