docs: prepare README and CHANGELOG for 0.1.0 release#32
Merged
LautaroParada merged 1 commit intomasterfrom Apr 9, 2026
Merged
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
0.1.0release without performing any build or upload steps.Description
README.mdto a sober, public-facing document that describes the package asvariance-test, lists installation commands (pip install variance-testandpip install -e .), current scope, weak-form battery contents, usage examples consistent with the public API, examples list, interpretation notes, release status, local release process, and development notes.CHANGELOG.mdand added an entry for## [0.1.0] - YYYY-MM-DDwithAdded,Changed, andNotessubsections summarizing the actual implemented functionality (packaging undersrc/, public API,input_kindsupport, normalization utilities, weak-form battery v1, partial rolling support, examples, CI, and hardening).0.1.0target as documentation only.README.md,CHANGELOG.md, and no other files were changed.Testing
pytest -q, which completed successfully with81 passedand4 warnings.Codex Task