Skip to content

doc: add Testing.md - #5420

Open
jinhgkim wants to merge 1 commit into
AcademySoftwareFoundation:mainfrom
jinhgkim:testmd
Open

doc: add Testing.md#5420
jinhgkim wants to merge 1 commit into
AcademySoftwareFoundation:mainfrom
jinhgkim:testmd

Conversation

@jinhgkim

Copy link
Copy Markdown
Collaborator

Description

Fixes #4760.

Replaced testsuite/TESTSUITE-README.md with a more complete version at docs/dev/Testing.md.

Used LLM to write the first draft and to cross-check the accuracy of the final version against the codebase. The draft was far too verbose, and cutting it down to something people would actually read took me quite a bit of time.

Assisted-by: Claude Code / claude-opus-5

Tests

No test needed.

Checklist:

  • I have read the guidelines on contributions and code review procedures.
  • I have read the Policy on AI Coding Assistants
    and if I used AI coding assistants, I have an Assisted-by: TOOL / MODEL
    line in the pull request description above.
  • I have updated the documentation if my PR adds features or changes
    behavior.
  • I am sure that this PR's changes are tested in the testsuite.
  • I have run and passed the testsuite in CI before submitting the
    PR, by pushing the changes to my fork and seeing that the automated CI
    passed there. (Exceptions: If most tests pass and you can't figure out why
    the remaining ones fail, it's ok to submit the PR and ask for help. Or if
    any failures seem entirely unrelated to your change; sometimes things break
    on the GitHub runners.)
  • My code follows the prevailing code style of this project and I
    fixed any problems reported by the clang-format CI test.
  • If I added or modified a public C++ API call, I have also amended the
    corresponding Python bindings. If altering ImageBufAlgo functions, I also
    exposed the new functionality as oiiotool options.

Used LLM to write the first draft and to cross-check the accuracy
of the final version against the codebase. The draft was far too
verbose, and cutting it down to something people would actually read
took me quite a bit of time.

Assisted-by: Claude Code / claude-opus-5
Signed-off-by: Jinnie Kim <jinhgkim@gmail.com>
@jinhgkim

Copy link
Copy Markdown
Collaborator Author

I wrote it in a way that makes sense to me, but am not sure if it would make sense to others as well.

Feedback welcome.

Comment thread AGENTS.md
Comment on lines 77 to 81
- For platform-specific diffs, add a variant ref (e.g. `out-win.txt`) rather
than overwriting
- Be conservative loosening image diff thresholds — use the minimum needed
- Check uploaded CI artifacts before changing references when local
reproduction is unclear

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory, we could drop these as they now live in Testing.md, and the coding assistant will read Testing.md as stated on line 75, BUT it may not prioritize those points as heavily as before. If we want to remove redundancy, we should remove it, and if we want those critical points to be prioritized by the agent, we should keep them. Let me know what you think, @lgritz.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Need Testing.md

1 participant