docs: explain model fixture and snapshot workflow - #1031
Open
CAOShurong wants to merge 2 commits into
Open
Conversation
Signed-off-by: Shurong Cao <170531907+CAOShurong@users.noreply.github.com>
Up to standards ✅🟢 Issues
|
jkowalleck
added
documentation
jkowalleck
reviewed
Aug 13, 2026
jkowalleck
left a comment
jkowalleck
left a comment
Member
There was a problem hiding this comment.
Thanks for the effort.
more docs -> more good!
Describe the exact string comparison used by SnapshotMixin without implying a raw byte comparison. Assisted-by: OpenAI Codex <noreply@openai.com> Signed-off-by: Shurong Cao <170531907+CAOShurong@users.noreply.github.com>
Contributor
Author
|
@jkowalleck, the byte-for-byte wording was corrected in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Document the shared BOM model fixture workflow in
tests/_data/snapshots/README.md:get_bom_*factories are discovered and named;The existing README only documented the recreation command. This fills the documentation gap identified by the maintainer in #914 without changing test behavior.
Resolves or fixes issue: #1030
Validation
python -m unittest tests.test_output_json tests.test_output_xml tests.test_deserialize_json tests.test_deserialize_xml— 750 tests passed.python -m unittest discover -t . -s tests— 6,962 tests passed.git diff --check— passed.AI Tool Disclosure
OpenAI CodexGPT-5Audit maintainer-requested CycloneDX contribution paths, verify repository rules and duplicates, document the existing tests/_data/models.py fixture and snapshot workflow, and run focused and complete regression tests.Affirmation