Skip to content

docs(readme): stop quoting a unit-suite pass count - #436

Merged
DrunkOnJava merged 3 commits into
mainfrom
test/readme-stop-quoting-test-counts
Oct 28, 2026
Merged

DrunkOnJava merged 3 commits into
mainfrom
test/readme-stop-quoting-test-counts

Conversation

@DrunkOnJava

@DrunkOnJava DrunkOnJava commented Oct 28, 2026 •

Copy link
Copy Markdown
Owner

Summary

README.md and STATUS.md quote "921 tests" from 2026-10-27, a count that included the inline #[cfg(test)] suites no job runs since #428, and STATUS.md lists the integration tests by count (including two unit-classed files and a WASM count from a crate whose tests no CI job runs). A unit-suite pass count is not evidence.

  • tests/fixtures/canonical/README.md: names the Test job's step, which is no longer cargo test, and says the byte-built R14 fixtures it cited are unit tests no job runs.
  • README.md: the "What works today" sentence points at the Corpus job instead of a count; the Verification block shows tools/ci/run_test_targets.sh --release --all-features; the contributor checklist names the runner and says unit tests are banned.
  • STATUS.md: the Tests, WASM tests and Integration tests bullets become one that names what CI runs, with no count. The generated coverage lines are untouched (python3 tools/maintainer/readme_status.py --check passes).

Lands after #428 (the runner it names) and after the area deletions (#429 to #434). Held back from #428 because open PRs touch these two files.

Spec reference

Not a decoder change.

Test plan

  • python3 tools/maintainer/readme_status.py --check passes.
  • CI evidence, run 40676560553, all 24 checks green (docs only; the generated README and STATUS blocks are unchanged).

Source-provenance declaration

By submitting this PR I certify that my contribution does not incorporate executable code from any source whose license is incompatible with Apache-2.0. Specifically:

  • No Autodesk DWG SDK source (RealDWG, ObjectARX, ObjectDBX) or NDA-protected Autodesk documentation was consulted or imported.
  • No Open Design Alliance Teigha / Drawings SDK source was consulted or imported. The ODA's public Open Design Specification for .dwg files PDF is explicitly allowed (see CLEANROOM.md).
  • No GPL-licensed DWG implementation source (LibreDWG, etc.) was consulted or imported. This matters because dwg-rs is Apache-2.0 and must remain compatible.

My contribution is based on:

  • The ODA's freely-redistributable Open Design Specification for .dwg files (v5.4.1);
  • Public reverse-engineering notes, research papers, or blog posts cited inline;
  • Reading algorithm-description comments (not executable code) in permissively-licensed projects (MIT / Apache / BSD) to resolve spec ambiguities: none were read for this change.

See CLEANROOM.md for the full allowed/forbidden source list and the honest scope of what "clean-room" means for this project.

Developer Certificate of Origin

By submitting this PR, I certify that the contribution complies with the Developer Certificate of Origin 1.1. Specifically, I affirm that the contribution is my own work (or rightfully licensed to me) and that it can be distributed under the project's Apache-2.0 license.

README.md and STATUS.md quoted "921 tests" from 2026-10-27, a count that
included the inline unit suites no job runs now, and STATUS.md listed the
integration tests by count. A unit-suite pass count is not evidence. Both
now name the targets CI runs and the command, and README.md's contributor
checklist points at tools/ci/run_test_targets.sh and the ban.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-28T14:00:33.902857Z e2ea791 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 55fc30933b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Resolved
tests/fixtures/canonical/README.md said canonical_corpus and block_names run
under `cargo test`, in a step of that name. The Test job runs them through
tools/ci/run_test_targets.sh, and the byte-built R14 fixtures it cited are
unit tests no job runs.
@DrunkOnJava
DrunkOnJava enabled auto-merge (squash) October 28, 2026 14:05
@DrunkOnJava
DrunkOnJava merged commit 3682107 into main Oct 28, 2026
24 checks passed
@DrunkOnJava
DrunkOnJava deleted the test/readme-stop-quoting-test-counts branch October 28, 2026 14:13
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.

1 participant