Add root evidence artifact policy - #27
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the .gitignore file to exclude various image and markdown debug artifacts from the repository root and adds a new 'Evidence artifact hygiene' section to the release checklist documentation. The documentation changes provide guidelines for managing generated evidence within the output/ directory. A review comment suggested clarifying that since the output/ directory is ignored by Git, artifacts should be uploaded directly to pull requests or issues while referencing the local path for traceability.
|
|
||
| - Keep generated screenshots, browser reports, debug snapshots, and one-off visual evidence under `output/`. | ||
| - Do not leave root-level files such as `*.png`, `*-snapshot.md`, `*-screenshot.md`, or `*-debug.md`; move them into a named folder like `output/manual-evidence/YYYY-MM-DD-short-topic/`. | ||
| - If evidence must be linked from a PR or issue, reference the `output/...` path in the PR body or issue comment instead of committing ad hoc root artifacts. |
There was a problem hiding this comment.
The instruction to "reference the output/... path" in a PR or issue body may be confusing for reviewers, as the output/ directory is ignored by Git and its contents are not available to others. It is recommended to explicitly advise uploading the artifact to the PR or issue comment directly, while mentioning the local path for traceability.
| - If evidence must be linked from a PR or issue, reference the `output/...` path in the PR body or issue comment instead of committing ad hoc root artifacts. | |
| - If evidence must be linked from a PR or issue, upload the artifact to the PR/issue comment and mention its `output/...` path for traceability instead of committing ad hoc root artifacts. |
Summary
docs/release-checklist.md.rssmaster-sources-simplified-1440.pngfrom the repository root.Closes #15
Local artifact cleanup
Preserved the root evidence under ignored output before cleanup:
output/manual-evidence/2026-05-25-root-artifact-cleanup/active-filter-chips-snapshot.mdoutput/manual-evidence/2026-05-25-root-artifact-cleanup/active-filter-chips.pngoutput/manual-evidence/2026-05-25-root-artifact-cleanup/rssmaster-sources-simplified-1440.pngValidation
git status --short --branchin the issue worktree: clean after commit, branch ahead 1 before push.C:\Users\user\Desktop\RSSmaster: no matching root screenshot/snapshot/debug artifacts after move.git ls-files | Where-Object { $_ -match '^[^/]+\\.(png|jpg|jpeg|webp|gif)$' }: no tracked root image files after commit.git diff --checkpassed with CRLF warnings only.docs/release-checklist.mdnow states evidence belongs underoutput/.Tests not run
npm run buildwas not run because this is docs/gitignore/artifact cleanup only and does not touch frontend code.Risks
output/is ignored, so preserved local evidence is not portable through git; the PR documents the paths and intent.apps/web/public/, docs asset folders, or another explicit tracked path, not repo root.