Repository navigation
docs: D75, the three decisions before 1.0, and the notices in the crates - #170
Merged
Merged
Conversation
Issue #165 put three choices to the maintainer, who left them to their agent. D75 records them: the shared library's name will carry the crate's major version (its own PR follows); `emberwave-wgpu` will be split out of `emberwave-core` so that the core has no wgpu type in its API, with the inventory, the six core items the move has to open, the dependents, the tests, the order of the work and the risks (no code moves yet); and THIRD_PARTY_NOTICES.md goes into both crates. The third is done here: the notices are copied next to LICENSE into emberwave-core and emberwave-cli (`cargo package --list` shows them), scripts/check_license_copies.sh, a step of the lint job, keeps the copies equal to the root's, and CONTRIBUTING and D74 say so. They reach crates.io with the next publish, which needs the maintainer's approval. The README's 1.0 checklist says what is decided and still to do. Claude-Session: https://claude.ai/code/session_019fJGoCTvP5e7n599q3ZQ42
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
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.
Purpose
Issue #165 put three choices to the maintainer, who left them to their agent on 2026-11-19. D75 records the decisions with their reasons and what was not chosen, and the third is done in this PR.
Changes
emberwave-wgpuis split out ofemberwave-core, with the inventory and the data (10,325 lines of GPU code against 6,934 of core, sixpub(crate)items to open, the dependents, the tests, the order of the work, the risks), no code moves; (3) THIRD_PARTY_NOTICES.md goes into both crates.crates/emberwave-core/THIRD_PARTY_NOTICES.mdandcrates/emberwave-cli/THIRD_PARTY_NOTICES.md, copies of the root file;cargo package --list -p emberwave-core -p emberwave-clinow lists them.scripts/check_license_copies.sh, a new step of the lint job, fails when a copy ofLICENSEor of the notices differs from the root's.What it changes for a client
Nothing in the libraries. The notices reach crates.io with the next publish, which needs the maintainer's approval. To revert, delete the two copies and the script.
Testing
scripts/check_license_copies.shpasses;cargo package --listshows the notices in both crates. Docs, two copied files, one script and one CI step.