Skip to content

Commit 5bee2ff

Browse files
committed
fix(#194): keep agentic scaffold guidance provider-neutral
Update generated architect/design guidance to use provider-neutral issue/work item wording and rely on the markdown-authoring skill instead of duplicating copy-safe fence rules.
1 parent 7592a23 commit 5bee2ff

9 files changed

Lines changed: 71 additions & 23 deletions

File tree

.github/agents/architect.agent.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ Design or reshape changes that cross public commands, private helper boundaries,
6262
- If the user chooses full finalization, a GitHub issue draft is ready to paste or create from the final output.
6363
- If the user chooses design-package-only finalization, the output is clearly resumable later from an `Open questions /
6464
resume here` section.
65+
- Finalization output is copy-ready Markdown that applies the project `markdown-authoring` skill.
6566

6667
## Must not do
6768

@@ -71,4 +72,5 @@ Design or reshape changes that cross public commands, private helper boundaries,
7172
- Must not create or edit repository files when the task is still in design mode.
7273
- Must not return a full implementation plan or finished issue draft in the first reply when the user is clearly asking for a design discussion.
7374
- Must not leave the user guessing whether the final output is a handoff document, paste-ready issue text, or both.
75+
- Must not return finalization Markdown that skips the project `markdown-authoring` guidance.
7476
- Must not decide on its own that requested work is out of scope and then finalize the design without the user's confirmation.

.github/prompts/design-change.prompt.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Do not produce the full final design package in the first response unless the us
4949

5050
## Finalization output
5151

52+
All finalization output is copy-ready Markdown. Apply the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`) for copy-safe UI output, including any required wrapping, and do not add prose outside the final output.
53+
5254
If the user chooses **design package and GitHub issue draft**, return:
5355

5456
- a short usage note that explains:
@@ -85,12 +87,13 @@ In design-package-only mode:
8587
- do not include a GitHub issue draft
8688
- preserve the settled decisions clearly enough that the user can resume later
8789
- end with the next unresolved design decision or a short resume prompt the user can reuse later
90+
- still apply the `markdown-authoring` skill to the final response
8891

8992
## Repository-specific reminders
9093

9194
- Preserve the distinction between public PowerShell cmdlets and `% nova` CLI behavior.
9295
- Keep contributor docs, command help, website docs, changelog entries, and release notes separated by audience.
93-
- If the final design summary or GitHub issue draft is returned as Markdown or copy-ready UI output, format it according to the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
96+
- Final design summaries and GitHub issue drafts are always copy-ready Markdown output; apply the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
9497
- Draft issue text in English unless the user explicitly asks for another language.
9598
- If the task still has unresolved choices, end the turn with the next best question or the next design decision the user should make.
9699
- If unresolved choices remain and you offer finalization anyway, explain what is settled, what is unresolved, and what each finalization option will produce.

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
1212
- The new prompt appears after the Git question, defaults to `No`, and adds one shared Nova-maintained starter tree when enabled.
1313
- Example scaffolds now merge the existing example README with the Agentic starter README instead of flattening the example guide into the generic starter file.
1414
- The starter tree is now generated from a filtered mirror of Nova's own agentic `.github/` files, with a dedicated sync script and drift test so future scaffolds and `dist` stay aligned with the maintained source guidance.
15+
- The generated architect/design prompt now requires final design packages and issue/work item drafts to be returned as copy-ready Markdown using the project Markdown authoring guidance.
1516

1617
### Changed
1718

18-
- The architect/design flow now surfaces settled vs unresolved design items before finalization, offers explicit choices for full finalization vs design-package-only handoff, and clarifies how to use design notes versus the paste-ready GitHub issue draft.
19+
- The architect/design flow now surfaces settled vs unresolved design items before finalization, offers explicit choices for full finalization vs design-package-only handoff, clarifies how to use design notes versus the paste-ready GitHub issue draft, and requires finalization output to follow the project Markdown authoring guidance.
1920

2021
### Deprecated
2122

RELEASE_NOTE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ changes will be included in the next **stable** release!
1010

1111
- `Initialize-NovaModule` and `% nova init` now offer an optional Agentic Copilot starter package in both the minimal and example interactive scaffold flows.
1212
- The starter package follows a filtered mirror of Nova's maintained agentic guidance so newly scaffolded projects receive a broader Nova-style agentic baseline without Nova-specific CodeScene or docs-site surfaces.
13+
- Generated architect/design guidance now requires final design packages and issue/work item drafts to be returned as copy-ready Markdown using the project Markdown authoring guidance.
1314

1415
### Changed
1516

scripts/build/Sync-AgenticCopilotScaffold.psd1

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,13 +262,49 @@
262262
Old = '- Run `./run.ps1`'
263263
New = '- Run full regression tests'
264264
}
265+
@{
266+
Old = 'or GitHub release automation.'
267+
New = 'or release automation.'
268+
}
269+
@{
270+
Old = 'a GitHub issue-ready change design'
271+
New = 'a tracker-ready change design'
272+
}
273+
@{
274+
Old = 'an issue-ready change design'
275+
New = 'a tracker-ready change design'
276+
}
277+
@{
278+
Old = 'fully issue-ready'
279+
New = 'fully tracker-ready'
280+
}
281+
@{
282+
Old = 'and a GitHub issue draft'
283+
New = 'and an issue/work item draft'
284+
}
285+
@{
286+
Old = 'a GitHub issue draft'
287+
New = 'an issue/work item draft'
288+
}
289+
@{
290+
Old = 'GitHub issue draft'
291+
New = 'issue/work item draft'
292+
}
265293
@{
266294
Old = 'GitHub issue'
267-
New = 'issue'
295+
New = 'issue/work item'
296+
}
297+
@{
298+
Old = 'issue-ready change design'
299+
New = 'tracker-ready change design'
300+
}
301+
@{
302+
Old = 'issue drafting'
303+
New = 'issue/work item drafting'
268304
}
269305
@{
270-
Old = '- issue'
271-
New = '- Issue'
306+
Old = 'paste-ready GitHub text'
307+
New = 'paste-ready tracker text'
272308
}
273309
@{
274310
Old = '- `pwsh -NoLogo -NoProfile -File ./run.ps1` before completion'

src/resources/agentic-copilot/.github/agents/architect.agent.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Design or reshape changes that cross public commands, private helper boundaries,
1919
- Treat scope cuts, deferrals, and out-of-scope boundaries as proposals that require explicit user confirmation.
2020
- Before offering finalization when unresolved questions remain, summarize what is settled, what is still unresolved, and present the explicit next-step choices.
2121
- Support two finalization modes when the discussion is sufficiently scoped:
22-
- design package plus issue draft
22+
- design package plus issue/work item draft
2323
- design package only
24-
- Once the discussion is sufficiently scoped, produce an issue-ready change design with acceptance criteria, out-of-scope boundaries, and a issue draft.
24+
- Once the discussion is sufficiently scoped, produce a tracker-ready change design with acceptance criteria, out-of-scope boundaries, and an issue/work item draft.
2525

2626
## Inputs to inspect
2727

@@ -50,17 +50,18 @@ Design or reshape changes that cross public commands, private helper boundaries,
5050
- Avoid introducing new abstractions unless the current structure clearly duplicates or conflicts.
5151
- Do not edit repository files unless the user explicitly asks to move from design into implementation.
5252
- Do not finalize the full design package until the user says the discussion is done, or you explicitly ask whether you should finalize it now.
53-
- Do not ask to finalize as if the change is fully issue-ready when unresolved questions still exist; surface those unresolved items explicitly before asking how the user wants to proceed.
53+
- Do not ask to finalize as if the change is fully tracker-ready when unresolved questions still exist; surface those unresolved items explicitly before asking how the user wants to proceed.
5454
- Do not finalize out-of-scope decisions unless the user has explicitly confirmed them.
5555

5656
## Definition of done
5757

5858
- The affected layers and files are clearly identified.
5959
- The scoped implementation approach matches existing repo structure.
6060
- Validation, documentation impact, and follow-on agent ownership are called out explicitly.
61-
- If the user chooses full finalization, a issue draft is ready to paste or create from the final output.
61+
- If the user chooses full finalization, an issue/work item draft is ready to paste or create from the final output.
6262
- If the user chooses design-package-only finalization, the output is clearly resumable later from an `Open questions /
6363
resume here` section.
64+
- Finalization output is copy-ready Markdown that applies the project `markdown-authoring` skill.
6465

6566
## Must not do
6667

@@ -70,4 +71,5 @@ Design or reshape changes that cross public commands, private helper boundaries,
7071
- Must not create or edit repository files when the task is still in design mode.
7172
- Must not return a full implementation plan or finished issue draft in the first reply when the user is clearly asking for a design discussion.
7273
- Must not leave the user guessing whether the final output is a handoff document, paste-ready issue text, or both.
74+
- Must not return finalization Markdown that skips the project `markdown-authoring` guidance.
7375
- Must not decide on its own that requested work is out of scope and then finalize the design without the user's confirmation.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Read these files before making non-trivial changes:
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

2121
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 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.
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.
2323

2424
## Repository map
2525

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ applyTo: "CHANGELOG.md,RELEASE_NOTE.md,project.json,.github/pull_request_templat
66

77
## Scope
88

9-
Use this file when changing versioning, changelog handling, package metadata, publish workflows, or GitHub release automation.
9+
Use this file when changing versioning, changelog handling, package metadata, publish workflows, or release automation.
1010

1111
## Versioning rules
1212

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

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Design a {{ProjectName}} change
22

3-
Use this prompt with `architect.agent.md` when a change still needs analysis, scoping, and issue drafting before anyone starts editing files.
3+
Use this prompt with `architect.agent.md` when a change still needs analysis, scoping, and issue/work item drafting before anyone starts editing files.
44

5-
This is a discussion-first prompt. The default behavior is to hold a short design conversation with the user before producing a final scoped solution, implementation handoff, or issue draft.
5+
This is a discussion-first prompt. The default behavior is to hold a short design conversation with the user before producing a final scoped solution, implementation handoff, or issue/work item draft.
66

77
Scope is not final until the user confirms it. That includes anything you think should be treated as out of scope, deferred, split into follow-up work, or excluded from the first implementation pass.
88

@@ -26,11 +26,11 @@ Scope is not final until the user confirms it. That includes anything you think
2626
- list what is already settled
2727
- list what is still unresolved
2828
- offer three explicit choices:
29-
- finalize with design package and issue draft
29+
- finalize with design package and issue/work item draft
3030
- finalize with design package only
3131
- keep discussing
3232
8. Keep the conversation interactive until the user explicitly confirms the scope is correct and says the task is clear enough to finalize, or until you explicitly ask whether you should now draft the final output and the user chooses one of those options.
33-
9. Only after that discussion is complete, produce the final scoped solution and implementation handoff, and include the issue draft only when the user chose the full-finalization option.
33+
9. Only after that discussion is complete, produce the final scoped solution and implementation handoff, and include the issue/work item draft only when the user chose the full-finalization option.
3434
10. Do not edit repository files unless the user explicitly switches from design to implementation.
3535

3636
## Discussion-phase output
@@ -49,11 +49,13 @@ Do not produce the full final design package in the first response unless the us
4949

5050
## Finalization output
5151

52-
If the user chooses **design package and issue draft**, return:
52+
All finalization output is copy-ready Markdown. Apply the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`) for copy-safe UI output, including any required wrapping, and do not add prose outside the final output.
53+
54+
If the user chooses **design package and issue/work item draft**, return:
5355

5456
- a short usage note that explains:
55-
- the sections before `issue draft` are design/handoff notes
56-
- only the `issue draft` section is paste-ready GitHub text
57+
- the sections before `issue/work item draft` are design/handoff notes
58+
- only the `issue/work item draft` section is paste-ready tracker text
5759
- Problem
5860
- Why it matters
5961
- Scope
@@ -63,10 +65,10 @@ If the user chooses **design package and issue draft**, return:
6365
- Proposed implementation approach
6466
- Open questions
6567
- Recommended follow-on agent
66-
- Issue draft
68+
- issue/work item draft
6769

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

7173
If the user chooses **design package only**, return:
7274

@@ -82,17 +84,18 @@ If the user chooses **design package only**, return:
8284

8385
In design-package-only mode:
8486

85-
- do not include a issue draft
87+
- do not include an issue/work item draft
8688
- preserve the settled decisions clearly enough that the user can resume later
8789
- end with the next unresolved design decision or a short resume prompt the user can reuse later
90+
- still apply the `markdown-authoring` skill to the final response
8891

8992
## Repository-specific reminders
9093

9194
- Preserve the distinction between public PowerShell cmdlets and `% nova` CLI behavior.
9295
- Keep contributor docs, command help, project docs, changelog entries, and release notes separated by audience.
93-
- If the final design summary or issue draft is returned as Markdown or copy-ready UI output, format it according to the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
96+
- Final design summaries and issue/work item drafts are always copy-ready Markdown output; apply the `markdown-authoring` skill (`.github/skills/markdown-authoring/SKILL.md`).
9497
- Draft issue text in English unless the user explicitly asks for another language.
9598
- If the task still has unresolved choices, end the turn with the next best question or the next design decision the user should make.
9699
- If unresolved choices remain and you offer finalization anyway, explain what is settled, what is unresolved, and what each finalization option will produce.
97-
- If you return both design notes and a issue draft, explicitly tell the user how to use each part.
100+
- If you return both design notes and an issue/work item draft, explicitly tell the user how to use each part.
98101
- If you think some requested work should be deferred or excluded, ask for confirmation before turning that judgment into the final scope or issue draft.

0 commit comments

Comments
 (0)