From 210bf040bea84451e226b3b15c85fdfea23a88bf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 19 Apr 2026 22:50:38 +0000 Subject: [PATCH] docs: document .vscode/ config and auto-generated workflow files README layout section and CONTRIBUTING workflow-files section both omitted three files that landed in the initial commit: .vscode/mcp.json, agentics-maintenance.yml, and copilot-setup-steps.yml. - Add .vscode/ block to the repository layout diagram (mcp.json, settings.json) - Add agentics-maintenance.yml and copilot-setup-steps.yml to the layout diagram with one-line descriptions - Add VS Code note to Local development section pointing to mcp.json - Add auto-generated files callout in CONTRIBUTING.md workflow-files section so contributors know not to edit them by hand Co-Authored-By: Claude Sonnet 4.6 --- CONTRIBUTING.md | 5 +++++ README.md | 8 ++++++++ 2 files changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3d9b58..7af9241 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -100,6 +100,11 @@ Never test by committing untested changes to `main`. The installed workflows run The `.github/workflows/` directory contains seven dogfooded workflows. These are managed by `gh aw` — do not edit `.lock.yml` files by hand except to apply the OAuth tweak described in [skills/install/auth.md](skills/install/auth.md). +Two additional files are auto-generated by `gh aw` and must not be edited manually: + +- **`agentics-maintenance.yml`** — closes/expires issues, discussions, and PRs created by workflows that use the `expires:` field in their safe-outputs configuration. Regenerated automatically by `gh aw compile` whenever any workflow uses `expires:`. +- **`copilot-setup-steps.yml`** — installs the `gh-aw` extension for GitHub Copilot Agent via `gh-aw-actions/setup-cli`. Required if you use Copilot Agent on this repository. + If a workflow `.md` source needs changing: 1. Edit the `.md` file. diff --git a/README.md b/README.md index 683652b..cb4d06f 100644 --- a/README.md +++ b/README.md @@ -134,8 +134,14 @@ skills/ markdown-linter.{md,lock.yml} pr-nitpick-reviewer.{md,lock.yml} weekly-research.{md,lock.yml} + agentics-maintenance.yml # auto-generated; expires workflow-created issues/discussions/PRs + copilot-setup-steps.yml # installs gh-aw for GitHub Copilot Agent shared/ reporting.md # shared reporting component (run-link formatting) + +.vscode/ + mcp.json # wires gh aw mcp-server into VS Code's MCP integration + settings.json # enables GitHub Copilot for Markdown files ``` `.lock.yml` files are marked as `linguist-generated` and `merge=ours` in `.gitattributes` to prevent spurious merge conflicts. @@ -148,6 +154,8 @@ claude --plugin-dir . Changes to `skills/*/SKILL.md` take effect on the next Claude Code session reload. Changes to `.lock.yml` files can be validated at any time with `gh aw validate` (safe — does not recompile). +**VS Code users**: `.vscode/mcp.json` wires `gh aw mcp-server` into VS Code's MCP integration automatically — no extra setup needed. + ## Publishing Once v0.1 is scope-locked: