docs: add framework audit, CONTRIBUTING, and modernize README metadata#45
Open
christopherkarani wants to merge 1 commit intomainfrom
Open
docs: add framework audit, CONTRIBUTING, and modernize README metadata#45christopherkarani wants to merge 1 commit intomainfrom
christopherkarani wants to merge 1 commit intomainfrom
Conversation
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.
Motivation
README.md.CONTRIBUTING.mdso new contributors and CI know how to run tests and open PRs.Description
README.mdto a compact, accurate quick-start covering SPM install, supported platforms (iOS 18 / macOS 15), core API shape, and a short “when to use / when not to use” section.CONTRIBUTING.mdthat documents local development, test invocation (swift test), PR expectations, and reporting guidance.docs/framework-audit-2026-03-06.mdcontaining the full audit (summary, bug table, type-system & concurrency recommendations, naming/namespace remarks, and a TDD-focused next-step plan).Testing
swift test --filter READMEExamplesTests, which failed with an unrelated package layout error:error: 'wax': invalid custom path 'Tests/WaxTests' for target 'waxTests'.Codex Task