docs: ask for pictures in issues and pull requests

The bug template's Evidence asks for a screenshot or recording first,
marked up, and a section for meshes; the feature template gains a
Pictures field; the pull request template and CONTRIBUTING ask for
before/after pictures of any visible change.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01UhhZMBTviDQxZvwnyP89fo
This commit is contained in:
jyvikoandClaude Opus 5.5 authored and Irakli Kourtis committed 2026-10-17 10:57:58 -04:00
1 parent 8cd37e0a68
commit 1daee9d969
4 files changed
+21 -2

No files matched your search

+2 -1
View File
@@ -24,7 +24,8 @@ body:
id: evidence id: evidence
attributes: attributes:
label: Evidence label: Evidence
description: Screenshots, log output, numbers. For a crash, attach the crash report (`fieldcraft-cli crashes`, then `crashes show <id>`). description: |
Pictures first: for anything you can see (the view, a mesh, a panel, a plot), drag a screenshot or a short screen recording in here, and mark the problem on it. For a mesh, a section through it (`fieldcraft-cli snapshot … --section`) shows what the outside hides. Then log output and numbers. For a crash, attach the crash report (`fieldcraft-cli crashes`, then `crashes show <id>`).
- type: textarea - type: textarea
id: expected id: expected
attributes: attributes:
+5
View File
@@ -21,6 +21,11 @@ body:
attributes: attributes:
label: Expected behaviour label: Expected behaviour
description: What FieldCraft should do, as precisely as you can. description: What FieldCraft should do, as precisely as you can.
- type: textarea
id: pictures
attributes:
label: Pictures
description: A screenshot of where it would go, a sketch, or a picture of the result you are after. Drag images in here.
- type: textarea - type: textarea
id: reference id: reference
attributes: attributes:
+4
View File
@@ -2,10 +2,14 @@ Closes #
## What and why ## What and why
## Before and after
<!-- For any visible change (the view, meshes, panels, results, icons): a picture before and after. Drag them in here. -->
## How it was verified ## How it was verified
<!-- Tests added or changed; oracle cases (tests/oracle) for solver and meshing results, with their cited references. --> <!-- Tests added or changed; oracle cases (tests/oracle) for solver and meshing results, with their cited references. -->
## Checklist ## Checklist
- [ ] The issue was assigned to me before I started (see CONTRIBUTING.md) - [ ] The issue was assigned to me before I started (see CONTRIBUTING.md)
- [ ] `cargo fmt --all`, `cargo clippy -p <crates I touched> --all-targets -- -D warnings` and their tests pass - [ ] `cargo fmt --all`, `cargo clippy -p <crates I touched> --all-targets -- -D warnings` and their tests pass
- [ ] Before/after pictures for any visible change
- [ ] No code, text or data from GPL-family projects or commercial CAE products - [ ] No code, text or data from GPL-family projects or commercial CAE products
+10 -1
View File
@@ -68,6 +68,13 @@ Every change starts from an issue, and only the maintainer merges.
Issues labelled **in progress** are being worked on by the core team; please don't start on them. Issues labelled **in progress** are being worked on by the core team; please don't start on them.
## Reporting a problem or an idea
Use the templates under **New issue**. Show it: for anything you can see — the view, a mesh, a
panel, a plot — add a screenshot or a short screen recording (drag it into the issue) and mark
the problem on it. For a mesh, a section (`fieldcraft-cli snapshot … --section`) shows what the
outside hides. A picture is often the fastest way for someone else to see what you see.
## Making the change ## Making the change
1. Branch from `develop` (the trunk; `main` holds released code only) and open the pull request 1. Branch from `develop` (the trunk; `main` holds released code only) and open the pull request
@@ -78,7 +85,9 @@ Issues labelled **in progress** are being worked on by the core team; please don
3. User-visible behaviour is a command (`crates/engine/src/cmd/`) with tests, including hostile 3. User-visible behaviour is a command (`crates/engine/src/cmd/`) with tests, including hostile
parameters. parameters.
4. Meshing and solver algorithms cite the paper they come from in the module docs. 4. Meshing and solver algorithms cite the paper they come from in the module docs.
5. Never contribute code, text or data from GPL-family projects or commercial CAE products 5. A change you can see (the view, meshes, panels, results, icons) shows a picture before and after
in the pull request.
6. Never contribute code, text or data from GPL-family projects or commercial CAE products
(see [docs/adr/0001-libraries.md](docs/adr/0001-libraries.md)). (see [docs/adr/0001-libraries.md](docs/adr/0001-libraries.md)).
By contributing you agree your work is licensed under MIT OR Apache-2.0. By contributing you agree your work is licensed under MIT OR Apache-2.0.