diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 6e65ee1..aa6acfc 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,21 +1,46 @@ name: Bug report -description: Something FieldCraft does wrong, or a crash +description: Something FieldCraft does wrong, a wrong result, or a crash labels: [bug] body: - type: textarea - id: what + id: observed attributes: - label: What happened - description: What you did, what you expected, and what FieldCraft did instead. + label: Observed failure + description: Exactly what happened. Quote error messages and wrong numbers as they appear. validations: required: true - type: textarea - id: reproduce + id: reproduction attributes: - label: How to reproduce - description: The commands, script, `.fieldcraft` or `.solidcraft` file that shows it. For a crash, attach the crash report folder (`fieldcraft-cli crashes`). + label: Reproduction + description: Numbered steps, or a script (`fieldcraft-cli run script.json`, control-channel JSON lines), with the sample, corpus part or attached `.fieldcraft` / `.solidcraft` file that shows it. + placeholder: | + 1. fieldcraft --sample cantilever + 2. Mesh ▸ Tet ▸ OK + 3. ... + validations: + required: true + - type: textarea + id: evidence + attributes: + label: Evidence + description: Screenshots, log output, numbers. For a crash, attach the crash report (`fieldcraft-cli crashes`, then `crashes show `). + - type: textarea + id: expected + attributes: + label: Expected behaviour + description: What should happen instead, and why — a closed form, a published benchmark, the documentation, or how the rest of the app behaves. Never output from a commercial CAE product. + validations: + required: true + - type: textarea + id: investigation + attributes: + label: Investigation + description: Anything you found about the cause — code you suspect, what you ruled out. Leave empty if you have not looked. - type: input id: version attributes: label: Version and platform - placeholder: "v0.1.0, macOS 15 arm64" + placeholder: "v0.1.0 (or commit), macOS 15 arm64" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 7556c55..489165e 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -2,6 +2,13 @@ name: Feature request description: A capability FieldCraft should have labels: [enhancement] body: + - type: textarea + id: current + attributes: + label: Current behaviour + description: What you can and cannot do today, and what happens when you try. + validations: + required: true - type: textarea id: need attributes: @@ -9,8 +16,13 @@ body: description: The analysis or workflow you are trying to do. validations: required: true + - type: textarea + id: expected + attributes: + label: Expected behaviour + description: What FieldCraft should do, as precisely as you can. - type: textarea id: reference attributes: label: References - description: Papers, textbooks or published benchmarks that define the behaviour. Do not paste text, files or results from commercial CAE products. + description: Papers, textbooks, public specifications or published benchmarks that define the behaviour. Do not paste text, files or results from commercial CAE products.