docs: explain model fixture and snapshot workflow

[CAOShurong]

Description

Document the shared BOM model fixture workflow in tests/_data/snapshots/README.md:

• how get_bom_* factories are discovered and named;
• how valid and intentionally invalid fixtures are classified;
• when to register an intentionally incomplete dependency graph;
• how to regenerate, review, and verify snapshots safely.

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

• My contribution does not include any AI-generated content
• My contribution includes AI-generated content, as disclosed below:
  • AI Tools: OpenAI Codex
  • LLMs and versions: GPT-5
  • Prompts: Audit 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

• My code follows the CONTRIBUTING.md guidelines

[codacy-production]

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

_{NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.}

[jkowalleck]

Thanks for the effort.
more docs -> more good!

[CAOShurong]

@jkowalleck, the byte-for-byte wording was corrected in 698c855, and all current code/docs checks are green. Could you please re-review when convenient? Thank you.

[jkowalleck]

looks like there are 2 PRs opened by you, @CAOShurong , for the same scope/topic:

• docs: document model fixture discovery and snapshot recreation workflow #1043
• docs: explain model fixture and snapshot workflow #1031

please consolidate the content in just one PR, and close the other.

[CAOShurong]

Consolidated: closed #1043 and brought over the schema version constraint details into \ ests/_data/snapshots/README.md\ (commit 92919fe). All CI checks and DCO sign-offs are in place for review.

[read-the-docs-community]

Documentation build overview

📚 CycloneDX Python Library | 🛠️ Build #34473551 | 📁 Comparing 92919fe against latest (27b2d43)

  🔍 Preview build  

2 files changed

± autoapi/cyclonedx/model/vulnerability/index.html
± autoapi/cyclonedx/contrib/vulnerability/cvss/index.html

[jkowalleck]

thank you for taking care of the docs 🥇