Skip to content

Commit 46e200e

Browse files
committed
feat(#194): refine documentation for agentic scaffolds
- Clarify conversational flow for new or not-yet-scoped work - Improve instructions for handling unresolved questions - Streamline guidance on implementing issues and design packages
1 parent ef12976 commit 46e200e

7 files changed

Lines changed: 14 additions & 29 deletions

File tree

src/resources/agentic-copilot/.github/agents/release-manager.agent.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,11 @@ Handle versioning, changelog shaping, release-flow documentation, and publish au
3636

3737
- Treat release automation as high-risk.
3838
- Keep Keep a Changelog structure intact.
39-
- Use only the official Keep a Changelog section types in `CHANGELOG.md` and `RELEASE_NOTE.md`: `Added`, `Changed`,
40-
`Deprecated`, `Removed`, `Fixed`, and `Security`.
39+
- Use only the official Keep a Changelog section types in `CHANGELOG.md` and `RELEASE_NOTE.md`: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security`.
4140
- Do not invent extra changelog section headings such as `Documentation`; place documentation-related release notes under the official type that best matches the actual impact.
4241
- Distinguish contributor docs from end-user docs.
4342
- Treat `.github/pull_request_template.md` as the authoritative format for structured release summaries.
44-
- When the release summary is returned as Markdown or copy-ready UI output, it must follow the `markdown-authoring`
45-
skill (`.github/skills/markdown-authoring/SKILL.md`).
43+
- When the release summary is returned as Markdown or copy-ready UI output, it must follow the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
4644

4745
## Definition of done
4846

src/resources/agentic-copilot/.github/copilot-instructions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ Read these files before making non-trivial changes:
1818

1919
Prompt templates under `.github/prompts/*.prompt.md` are not auto-loaded. Reference them explicitly in chat when you want to use one of the repository's reusable task prompts.
2020

21-
For new or not-yet-scoped work, start with `.github/agents/architect.agent.md` and
22-
`.github/prompts/design-change.prompt.md`. That flow should stay conversational first: analyze the request, ask clarifying questions, present design options when needed, and only draft the final scoped solution or issue/work item after the discussion is complete. When unresolved questions still remain, architect should surface what is settled vs unresolved before asking whether to finalize, and should allow either full finalization or a resumable design-package-only handoff. Proposed scope cuts or out-of-scope boundaries must be confirmed by the user before they are treated as final.
21+
For new or not-yet-scoped work, start with `.github/agents/architect.agent.md` and `.github/prompts/design-change.prompt.md`. That flow should stay conversational first: analyze the request, ask clarifying questions, present design options when needed, and only draft the final scoped solution or issue/work item after the discussion is complete. When unresolved questions still remain, architect should surface what is settled vs unresolved before asking whether to finalize, and should allow either full finalization or a resumable design-package-only handoff. Proposed scope cuts or out-of-scope boundaries must be confirmed by the user before they are treated as final.
2322

2423
## Repository map
2524

src/resources/agentic-copilot/.github/instructions/powershell-coding-standards.instructions.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,7 @@ Use this file when changing `src/public/`, `src/private/`, or PowerShell build/r
4444

4545
### Spacing
4646

47-
- Use one space between language keywords and `(` in control statements such as `if (...)`, `foreach (...)`,
48-
`switch (...)`,
49-
`while (...)`, and `for (...)`.
47+
- Use one space between language keywords and `(` in control statements such as `if (...)`, `foreach (...)`, `switch (...)`, `while (...)`, and `for (...)`.
5048
- Use one space before an opening `{`.
5149
- Use one space around binary, comparison, and logical operators.
5250
- Use one space after commas in parameter and argument lists.

src/resources/agentic-copilot/.github/prompts/design-change.prompt.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,7 @@ If the user chooses **design package and issue/work item draft**, return:
6767
- Recommended follow-on agent
6868
- issue/work item draft
6969

70-
If unresolved questions still remain, keep them under `Open questions` in the design package and add a short `Open
71-
questions` section inside the issue/work item draft too.
70+
If unresolved questions still remain, keep them under `Open questions` in the design package and add a short `Open questions` section inside the issue/work item draft too.
7271

7372
If the user chooses **design package only**, return:
7473

src/resources/agentic-copilot/.github/prompts/implement-issue.prompt.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@ Implement the issue in the {{ProjectName}} repository using the repository-local
1010

1111
## Required process
1212

13-
1. If scope, acceptance criteria, or ownership are still unclear, start with `.github/prompts/design-change.prompt.md`
14-
and `architect.agent.md` before implementing.
13+
1. If scope, acceptance criteria, or ownership are still unclear, start with `.github/prompts/design-change.prompt.md` and `architect.agent.md` before implementing.
1514
2. Read `README.md`, `CONTRIBUTING.md`, `.github/copilot-instructions.md`, and `.github/pull_request_template.md`.
1615
3. Inspect the relevant public command, matching private helper domain, tests, and docs.
17-
4. If the issue is release-, workflow-, or coverage-related, also inspect the matching workflow files, when present and
18-
`scripts/build/ci/*.ps1` files.
16+
4. If the issue is release-, workflow-, or coverage-related, also inspect the matching workflow files, when present and `scripts/build/ci/*.ps1` files.
1917
5. Preserve the Nova build model: use `project.json` and Nova commands for build/test/package/release behavior, and do not create hand-written source `.psm1` or module `.psd1` files.
2018
6. Inspect `project.json` `Manifest.PowerShellHostVersion` before changing PowerShell code, tests, or examples, and keep the implementation compatible with that target.
2119
7. Implement the smallest maintainable fix.
@@ -25,8 +23,7 @@ Implement the issue in the {{ProjectName}} repository using the repository-local
2523
11. Review `README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, `RELEASE_NOTE.md`, help docs, and project docs as applicable.
2624
12. If a commit message is requested, derive it from `$GIT_BRANCH_NAME` and the implemented change using the repository's Conventional Commit rules.
2725
13. Run the relevant validation, then summarize what changed, why, and how it was verified.
28-
14. If that summary is returned as Markdown or copy-ready UI output, format it according to the `markdown-authoring`
29-
skill (`.github/skills/markdown-authoring/SKILL.md`).
26+
14. If that summary is returned as Markdown or copy-ready UI output, format it according to the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
3027

3128
## Repository-specific reminders
3229

src/resources/agentic-copilot/.github/prompts/prepare-release.prompt.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,19 @@ Prepare release-related changes in {{ProjectName}} without publishing or tagging
44

55
## Required process
66

7-
1. Read `CHANGELOG.md`, `RELEASE_NOTE.md`, `project.json`, `README.md`, `CONTRIBUTING.md`,
8-
`.github/pull_request_template.md`, and release workflow files, when present.
7+
1. Read `CHANGELOG.md`, `RELEASE_NOTE.md`, `project.json`, `README.md`, `CONTRIBUTING.md`, `.github/pull_request_template.md`, and release workflow files, when present.
98
2. Inspect the touched versioning, package, publish, or release tests.
109
3. Confirm whether the change affects stable releases, prereleases, or both.
1110
4. Update changelog, release notes, and contributor docs as needed.
12-
5. Use only the official Keep a Changelog section types in `CHANGELOG.md` and `RELEASE_NOTE.md`: `Added`, `Changed`,
13-
`Deprecated`, `Removed`, `Fixed`, and `Security`.
11+
5. Use only the official Keep a Changelog section types in `CHANGELOG.md` and `RELEASE_NOTE.md`: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security`.
1412
- Do not create custom headings such as `Documentation`; place documentation-related release notes under the official type that best matches the actual impact.
1513
6. Check whether `RELEASE_NOTE.md` needs the placeholder rule under `## [Unreleased]`:
16-
- If there are no real public API or workflow changes, ensure `### Added` contains exactly
17-
`No public API or workflow changes in this release. Internal maintenance only.`
14+
- If there are no real public API or workflow changes, ensure `### Added` contains exactly `No public API or workflow changes in this release. Internal maintenance only.`
1815
- If there are real release-note entries, remove that placeholder.
1916
7. Keep `RELEASE_NOTE.md` free of compare-link footer URLs.
2017
8. Validate the relevant release or versioning path.
2118
9. Summarize the result using the exact structure from `.github/pull_request_template.md`.
22-
10. Make the summary concise, reviewer-focused, directly reusable, and compliant with the `markdown-authoring` skill
23-
(`.github/skills/markdown-authoring/SKILL.md`) when the output is returned as Markdown.
19+
10. Make the summary concise, reviewer-focused, directly reusable, and compliant with the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`) when the output is returned as Markdown.
2420

2521
## Repository-specific reminders
2622

@@ -30,5 +26,4 @@ Prepare release-related changes in {{ProjectName}} without publishing or tagging
3026
- Keep unreleased changelog entries aligned with the final intended behavior, not internal iteration history.
3127
- Keep `CHANGELOG.md` exhaustive and keep `RELEASE_NOTE.md` limited to public interface, configuration, and migration changes.
3228
- Treat `.github/pull_request_template.md` as the source of truth for release-preparation summaries.
33-
- If the summary must be pasted as one Markdown block in the UI, it should follow the `markdown-authoring` skill
34-
(`.github/skills/markdown-authoring/SKILL.md`).
29+
- If the summary must be pasted as one Markdown block in the UI, it should follow the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).

src/resources/agentic-copilot/.github/prompts/review-change.prompt.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ Review a {{ProjectName}} change set with emphasis on correctness, maintainabilit
99
3. Check whether tests, docs, and changelog updates match the change.
1010
4. Call out the smallest set of meaningful issues first.
1111
5. Note any missing validation or follow-up work.
12-
6. If the review is returned as Markdown or copy-ready UI text, format it according to the `markdown-authoring` skill
13-
(`.github/skills/markdown-authoring/SKILL.md`).
12+
6. If the review is returned as Markdown or copy-ready UI text, format it according to the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
1413

1514
## Repository-specific reminders
1615

0 commit comments

Comments
 (0)