Free open-source image editor for the browser
Clarify PR evidence requirements (#24)
Rodrigo Belfioreb7a7389db341
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.mdindex d452fe5..3a41ff9 100644--- a/.github/pull_request_template.md+++ b/.github/pull_request_template.md@@ -1,6 +1,10 @@+<!-- Include evidence when opening the PR. Keep the description brief and direct;+link detailed reports, raw data and reproduction steps. Omit work logs. -->+## Change-<!-- Describe the problem and resulting behavior. -->+<!-- Describe the problem and resulting behavior in one or two sentences.+Add only the implementation details or tradeoffs needed to review the change. -->## Validation@@ -11,13 +15,18 @@<!-- UI additions or changes: embed actual screenshots with the affected controlsvisible in context for visual approval. Show before/after for existing UI changesand representative states for new UI. Rendered output alone is insufficient.-Rendering changes: also show before/after output. Nonvisual code changes: show-the exercised workflow. Name the fixture and settings; images must be accessible-from this PR. Documentation-only changes may mark this section not applicable. -->+Rendering changes: also show before/after output side by side, using the same+fixture and matching conditions; name the settings and state what varies.+Include relevant quality metrics when a reference or expected property exists;+state units and limits. Keep image-quality results separate from timings.+Nonvisual code changes: show the exercised workflow. Verify that image links+are accessible from this description. Documentation-only changes may mark+this section not applicable. -->## Rendering performance-<!-- Follow PERFORMANCE.md: reproducible base/head comparison, workload and-environment, timing scope, sample counts, median/p95, and interpretation.+<!-- Use a compact results table following PERFORMANCE.md: reproducible base/head+comparison, workload and environment, timing scope, sample counts, median/p95,+and a short interpretation. Link full measurements and reproduction steps.Separate neutral/bypass overhead from the cost of new active behavior.If rendering work is unaffected, explain why. Report missing evidence explicitly. -->diff --git a/AGENTS.md b/AGENTS.mdindex f322835..025380d 100644--- a/AGENTS.md+++ b/AGENTS.md@@ -64,7 +64,11 @@ Maintain the semantic [control API](API.md) for local, CI, and remote use. ExercRun `bun run check`, `bun run build`, `bun run test`, and `bun run test:browser` after changes and before a commit. Browser setup and focused commands are in [README.md](README.md#validation).-Every code PR includes actual application screenshots or rendered output demonstrating the result. UI additions or changes require screenshots of the affected interface in context, with the new or changed controls visible for visual approval; rendered output alone is insufficient. Show before/after for changes to existing UI or image output, representative states for new UI, and the affected workflow for nonvisual code changes. Embed accessible images in the PR and name the fixture and settings. Documentation-only changes may mark visual evidence not applicable.+Prepare evidence during implementation and include it in the initial PR description, using the [PR template](.github/pull_request_template.md). Lead with the problem and resulting behavior. Keep prose short, use compact comparison tables, and link detailed reports, raw data, and reproduction steps. Omit work logs and repeated explanations.++Every code PR includes actual application screenshots or rendered output demonstrating the result. UI additions or changes require screenshots of the affected interface in context, with the new or changed controls visible for visual approval; rendered output alone is insufficient. Show before/after for changes to existing UI or image output, representative states for new UI, and the affected workflow for nonvisual code changes. Compare the same fixture under matching conditions and state what varies. Embed accessible images in the description, name the fixture and settings, and verify the published links. Documentation-only changes may mark visual evidence not applicable.++For processing changes, include relevant quality measurements when a reference or expected property is available. State the metric, units, and limits; do not generalize from synthetic fixtures to real photos. Keep quality results separate from rendering timings.Assess performance on every code change; changes affecting GPU work require reproducible before/after evidence under [PERFORMANCE.md](PERFORMANCE.md). Report unavailable checks and measurements as verification gaps.