Skip to content

Bug, patch, and general forms use direct prompts - #21

Open
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
msx-intake-writing
Open

Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
msx-intake-writing

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

The bug, patch, and general issue forms name the information that reporters give. Their prompts use direct instructions without filler or a promise of a fast response. Existing fields and submission requirements do not change.

Changed: Issue forms use direct input instructions

The bug form identifies expected and actual behavior, the environment, reproduction steps, related information, and evidence. The patch form asks for the existing content or behavior and the desired change. The general form asks for the issue subject and related information.

All three forms retain their names, titles, labels, field IDs, field order, types, and required flags. The bug form keeps three required and two optional textareas. The patch and general forms each keep one required textarea. Repositories that use these shared forms need no configuration change.


Technical details

Source and plan: Repository baseline 0c67251812ea306543f3a14ab473ae357cfb76ac; final candidate deb2e80d65c1334a140c2f8c15eae738329542fb. The draft opened after bug-form commit e3e59ac00134eaec301506e2f01492d90faead9b. The second small commit completes the patch and general forms. Both commits are pushed, the working tree is clean, and all five implementation-plan steps in #16 are complete. The issue stays open until merge.

Before and after: All three introductions asked for "as much information as possible" and promised that "we can help you quickly." Each introduction now states the information its form records. The field wording also becomes specific:

Field Before After
Bug description A clear and concise description of what the bug is vs. what you expected to happen. Give the expected behavior and the actual behavior.
Bug environment What version, commit, platform, or configuration were you using when the problem occurred? Give the version, commit, platform, or configuration in use when the problem occurred.
Patch description A clear and concise description of what you would want to change. Give the existing content or behavior and the change you want.
General description A clear and concise description. Give the subject of the issue and the related information.

The pre-edit prose checks report 3 of 10 values passing and 7 failing. The final candidate passes all 10. Manual review confirms that the bug form retains its reproduction, related-details, and supporting-evidence intent. The environment prompt retains or; it does not require every listed environment value.

Complete contract comparison: An already installed PyYAML 6.0.3 parser compares the complete YAML tree against the captured baseline. It preserves mapping-key and field order, node types, scalar tags and styles, and every protected value. This includes top-level descriptions, all names and titles, IDs, labels, required flags, and routing. Only the three introduction strings and seven field-description strings are excluded. All three full non-prose contracts match, and the changed-file set contains exactly the three owned forms.

Local commands and results: The check script, original snapshot, and before/after logs remain in local session artifacts. They are one-time delivery evidence, not repository tests, validation tooling, or CI enforcement. PowerShell commands use:

$check = "$env:USERPROFILE\.copilot\session-state\73d907e5-c9b5-46c2-ab63-6404c149f36f\files\check_intake_forms.py"
Command Result
python $check structure Baseline passed: all three full non-prose contracts match and no repository files differ.
python $check prose Baseline failed as intended, exit 1: 3 values pass and 7 fail.
python $check all --forms bug Passed before the first commit: three full contracts match and all six bug-form prose values pass.
python $check all Passed before and after the final commit, exit 0: three full contracts match, all 10 prose values pass, and exactly the three owned forms differ.
python -m yamllint --strict .github\ISSUE_TEMPLATE\01-bug.yml .github\ISSUE_TEMPLATE\02-patch.yml .github\ISSUE_TEMPLATE\99-general.yml Passed on the baseline and final wording, exit 0, with already installed yamllint 1.38.0.
git diff --check Passed, exit 0.
git diff 0c67251812ea306543f3a14ab473ae357cfb76ac --check Passed across the complete delivery diff, exit 0.
git diff 0c67251812ea306543f3a14ab473ae357cfb76ac HEAD --check Passed after both commits were pushed, exit 0.
git diff --cached --check Passed before each small commit, exit 0.
git ls-remote --heads origin msx-intake-writing Passed: the remote branch points to deb2e80d65c1334a140c2f8c15eae738329542fb.

Standards and format: The final pass uses fixed MSXOrg/docs commit 1b0d4893c8fefabe604d04393068a8ff6f848082: Documentation Model, Natural Language, Writing Guide, Markdown, Documentation, YAML, Testing, and applicable issue/delivery/PR guidance. The Writing Guide preserves the native artifact format. The official STE overview, FAQ, and local Issue 9 rules and dictionary support manual review. The verified PDF and its extraction stay local. The checks do not prove full STE conformance.

The domain reference is the native GitHub issue-form format, not a spec/design template. There is no separate framework-specific documentation for these forms.

Changed surface Standards checked Framework docs checked Result
.github/ISSUE_TEMPLATE/01-bug.yml Direct en-US prompts, preserved technical meaning, YAML Native GitHub issue-form format Fixed in this PR
.github/ISSUE_TEMPLATE/02-patch.yml Direct en-US prompts, preserved technical meaning, YAML Native GitHub issue-form format Fixed in this PR
.github/ISSUE_TEMPLATE/99-general.yml Direct en-US prompts, preserved technical meaning, YAML Native GitHub issue-form format Fixed in this PR

Unchanged areas: The feature form, config.yml, tests, validation tooling, README, contribution guidance, PR template, agent instructions, profile, security, and support files remain unchanged. The repository's fallback role and central-standards link remain correct. No field, policy, linter, dependency, maintained phrase-freezing test, or capability scaffold is added.

Convergence: gh issue list --repo MSXOrg/.github --state open --search 'in:body ISSUE_TEMPLATE' --limit 50 --json number,title,body,url returns #16 and #14. The latter owns the feature form and is not satisfied by this diff. Only #16 receives a closing reference.

Review and open readiness gate: The current-head Copilot review is APPROVED at deb2e80d65c1334a140c2f8c15eae738329542fb, with no inline comments and zero review threads. The current-head check-run API reports one completed successful copilot-pull-request-reviewer check; the commit-status API reports zero statuses. There is no repository-validation check at this head. The review check does not establish hosted validation.

The baseline has no tracked validation scripts or lint configuration. Open #12 owns separate validation work; its files are not consumed here. The hosted-validation readiness gate remains open, not passed. All required writing sources are accessible, with no source or access blocker.

The PR remains in draft as requested. GitHub auto-merge is null. No merge or Agent merge action occurs.

Relevant issues (or links)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved

No active review issues are blocking the issue-form instruction updates.

No open issues 🎉

What changed in this PR

Updates the bug, patch, and general issue forms with direct input instructions so reporters know what information to provide.

Changes:

  • Replaces generic introductions with descriptions of each form’s purpose.
  • Clarifies prompts for bug details, requested changes, and general issues.
  • Preserves form fields, labels, required flags, and YAML structure.
File Description
.github/​ISSUE_TEMPLATE/​99-general.yml Clarifies the form’s scope and requests the issue subject and related information.
.github/​ISSUE_TEMPLATE/​02-patch.yml Requests existing content or behavior and the desired change.
.github/​ISSUE_TEMPLATE/​01-bug.yml Makes bug-report prompts direct and specifies the expected information.

Review effort: Balanced

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.

[documentation-writing-alignment] Use direct prompts in bug, patch, and general issue forms

2 participants