Skip to content

Commit 236da40

Browse files
Feature requests start with the current situation and user value (#89)
<!-- Lead with one concise paragraph describing the user-facing outcome. --> Feature contributors give the current situation first, then the user benefit, the requested change, and an example of the expected result. The inherited PSModule feature form uses direct instructions and present-tense maintainer responsibilities. Its identity, declared labels, single required response, and feedback routing remain unchanged. No consumer-local edit or technical plan is necessary. <!-- ANNOUNCEMENT STOP --> <!-- Add user-facing sections for breaking, new, changed, or fixed behavior when needed. --> ## Changed: Feature requests establish the current situation before the desired change The response remains **Current situation and desired change**. The introduction removes the courtesy opening. The prompts give direct instructions in the same order: 1. Tell us how things work today. Include what is not easy or is missing. 2. Tell us who the change helps and why. 3. Tell us what you want to add or change. 4. Give a real example. Include the situation, your action, and the result you expect. Optional starters use ordinary language. Maintainers review and refine feedback, then select the issue type. The form does not require literal Gherkin syntax, architecture decisions, or a technical implementation plan. Tasks and Bugs retain their technical delivery plans. After merge, PSModule repositories that use inherited issue templates receive the organization-owned form without local configuration or code changes. Repositories with local overrides are unchanged. The chooser metadata, title prefix, `feature`/`triage` declarations, `description` field ID, single required textarea, field label, and blank-issue fallback remain unchanged. --- <details> <summary>Technical details</summary> <!-- Record the implementation approach, issue-plan progress, standards alignment, and convergence sweep. --> ### Scope and source identity Candidate: `7eedb8a44c00bfa0f38d541ea88a7d7d791eaa19` on `psmodule-feature-intake`. The complete PR changes only `.github\ISSUE_TEMPLATE\10-feature.yml`: 23 additions and 5 deletions against `f424237c98b5b020f80e8c9563dbc37256fc1ec0`. The prose revision is one ordinary commit after `e7a14f7eb35eb77bff8b6ba7730c8870a660185d`. It changes only the introduction, textarea description, and optional placeholder text. The form's Git blob changes from `8fb4a887c15961430e78980ac695a8af83029fbc` to `29b9a60ed7e77745fdcf7f0e22b66026c864036a`; the earlier identical-blob claim applies only to the completed test-removal correction, not this prose revision. Other campaign sessions own README/AGENTS/profile and bug/patch/general forms; this branch does not edit those paths. ### Prose acceptance evidence | Concern | Before this prose revision | After | Preserved result | | --- | --- | --- | --- | | Opening | Courtesy thanks before the first instruction | Starts with how things work today | Current situation first | | User benefit and requested change | Questions and conditional wording | Imperative Tell/Give prompts | User benefit precedes the requested change | | Expected result | A real-situation question | An example with situation, action, and expected result | Observable scenario without mandatory formal syntax | | Maintainer responsibility | Will review and decide how to route | Review and refine feedback, then select the issue type | Same maintainers and native routing; present tense | | Optional starters | Would help / would like | Change helps / I want | Same ordinary-language hints, not prefilled answers | A one-time read-only YAML comparison allowed changes only to `body[0].attributes.value`, `body[1].attributes.description`, and `body[1].attributes.placeholder`. The remaining keys and values matched the preceding source. This includes form identity, routing declarations, field ID, required flag, field label, and absence of an assigned native type. The reference URLs and untouched blank-issue configuration retain their roles. This comparison is maintenance evidence, not a retained snapshot test or a test of GitHub behavior. ### Fixed writing sources and limits The campaign uses MSXOrg/docs at `1b0d4893c8fefabe604d04393068a8ff6f848082`: [Documentation Model](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Ways-of-Working/Documentation-Model.md), [Natural Language](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Coding-Standards/Natural-Language.md), [Writing Guide](https://github.com/MSXOrg/docs/blob/1b0d4893c8fefabe604d04393068a8ff6f848082/src/docs/Coding-Standards/Writing-Guide.md), Markdown, Documentation, and the applicable issue/Task/PR formats. All required pages were available. The official [STE overview](https://www.asd-ste100.org/about_STE.html), [FAQ](https://www.asd-ste100.org/STE_faq.html), and [Issue 9 DOI](https://doi.org/10.5281/zenodo.23666006) were available. The PDF was read in memory, and its MD5 matched the official record. The review consulted active-voice rule 3.6, procedural rules 5.1-5.3, and relevant dictionary entries for prompt wording, including Tell/Give and alternatives to Explain/Describe. Reference content was not republished. This is a scoped manual prose review, not a full word-by-word STE certification. Domain terms retain their MSX meaning. A word count, static lint result, or automated approval does not prove complete STE conformance. ### Static checks and testing boundary | Existing command or inspection | Result and limit | | --- | --- | | `yamllint --strict .github\ISSUE_TEMPLATE\10-feature.yml` | Passed, exit 0. Existing static YAML lint only. | | `git --no-pager diff f424237 HEAD --check` | Passed. Whitespace inspection only. | | Read-only comparison against `e7a14f7eb35eb77bff8b6ba7730c8870a660185d` | Only permitted display values differ; non-prose keys and values are unchanged. No comparison script is committed. | | `gh api repos/PSModule/.github/pulls/89/files --paginate` | Exactly one changed file: the feature form, 23 additions/5 deletions. | The 198-line Pester snapshot suite remains removed. Its historical 25 assertions did not test GitHub rendering, submission, or routing; the earlier functional-coverage claim stays withdrawn. No replacement content assertions, schema snapshots, runtime simulation, test dependency, validator, workflow, hook, or test issue is added. No live GitHub form test was executed or claimed. Static/manual inspection and review do not establish that unexecuted coverage. Pre-commit alignment remains deferred, and the separate testing-policy cleanup remains independent. ### Plan, review, and lifecycle [#88](#88) records the new user-directed prose acceptance decision and the preserved testing boundary. Its earlier test-removal identity is historical evidence; current prose evidence uses the candidate above. **Original delivery checkpoint (November 4):** The [exact-head review](#89 (review)) approved the candidate at `2026-11-04T12:27:50Z`, with zero inline comments and no active review issues. Previous-head approvals are not reused. The November 4 review and static-check receipts above remain historical evidence, not a new review or current hosted CI result. **Original lifecycle-only pause:** At the November 4 checkpoint, this PR stayed unmerged while the requested independent testing-cleanup proposals were created. Agent merge and automatic landing were disabled. This records the original delivery checkpoint; it is not an outstanding requirement to adopt or merge those proposals. **Current prerequisite record (November 11):** The creation request is fulfilled by [MSXOrg/docs#240](MSXOrg/docs#240), [PSModule/Process-PSModule#551](PSModule/Process-PSModule#551), and the source-bound no-test audits of MSXOrg/.github and PSModule/.github. No native dependency requires adoption or merge of those unrelated proposals. No content question remains. The [fresh prerequisite and exact-head evidence](#88 (comment)) records those source identities, native relationships, fresh existing-tool checks, and their limits. The root has granted bounded operational acceptance of unchanged head `7eedb8a44c00bfa0f38d541ea88a7d7d791eaa19` under the user's live direction to review remaining changes and merge them when ready. The root has not granted this PR the exclusive global merge slot; Process owns it. A bounded exact-head squash is permitted only after that slot is granted. No merge or automatic landing is authorized now. The current native state remains open, not draft, and unmerged, with GitHub `autoMergeRequest=null`. Agent merge remains disabled; actions remain `address_reviews=true`, `fix_ci=true`, `resolve_conflicts=true`, and `merge_pr=false`. Current hosted check-runs and commit statuses are empty, not green CI. No changed coverage or organization rule is claimed. The absent-CI, static/manual-only, and STE verification limits remain in force. | Changed surface | Standards checked | Framework/domain docs checked | Result | | --- | --- | --- | --- | | Feature-form display prose | Fixed MSX writing baseline; relevant official STE rules/dictionary; existing YAML guidance | GitHub issue-form roles; native feedback refinement and Task/Bug planning boundaries | Fixed in this PR | | Removed-test state and evidence | MSX Testing: Test supported behavior | None (no owned form runtime) | Aligned; live behavior unexecuted | The exact feature-form-path issue sweep found this Task, the separate writing campaign issues, and the broader YAML work. No additional issue is fully delivered by this feature-only branch; this PR has only [#88](#88) as its closing delivery leaf. The Task remains open, and the PR is unmerged. Retired validator/governance work is not reinstated. Issue states/relationships, repository labels/protections, and other community files remain unchanged. </details> <details> <summary>Related references</summary> <!-- Use fully qualified repository references for closing and related work. --> - Resolves [#88](#88) ### Related work - References [MSXOrg/docs#228](MSXOrg/docs#228) - References [MSXOrg/docs#230](MSXOrg/docs#230) </details>
1 parent 4e0092d commit 236da40

1 file changed

Lines changed: 23 additions & 5 deletions

File tree

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
22
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
---
34
name: 🚀 [Feature]
45
description: Suggest/request a new feature
56
title: '🚀[Feature]: '
@@ -8,14 +9,31 @@ body:
89
- type: markdown
910
attributes:
1011
value: |
11-
Thank you for suggesting a new feature. Please provide as much information as possible so we can understand your request better.
12+
Start with how things work today.
13+
Tell us who the change helps and why.
14+
Then tell us what should change and what result you expect.
15+
Use your own words. A technical plan is not necessary.
16+
Maintainers review and refine feedback, then select the issue type.
17+
18+
See the [MSX issue guidance][issues] and
19+
[planning guidance][planning] for the work process.
20+
21+
[issues]: https://msx.no/docs/Ways-of-Working/Issues/
22+
[planning]: https://msx.no/docs/Ways-of-Working/Issues/Process/Planning/
1223
- type: textarea
1324
id: description
1425
attributes:
15-
label: Description
26+
label: Current situation and desired change
1627
description: |
17-
Please describe your idea/request
18-
Feel free to add suggestions how you would like to see this implemented.
19-
Are there alternatives you've considered?
28+
Tell us how things work today. Include what is not easy or is missing.
29+
Tell us who the change helps and why.
30+
Tell us what you want to add or change.
31+
Give a real example. Include the situation, your action,
32+
and the result you expect.
33+
placeholder: |
34+
Today, ...
35+
The change helps ... because ...
36+
I want to ...
37+
When I ..., I expect ...
2038
validations:
2139
required: true

0 commit comments

Comments
 (0)