Skip to content

Remove agent planning notes and tidy README and changelog - #3

Merged
ult666666 merged 1 commit into
mainfrom
audit-fixes
Oct 28, 2026
Merged

ult666666 merged 1 commit into
mainfrom
audit-fixes

Conversation

@ult666666

Copy link
Copy Markdown
Owner

Summary

  • Removed the docs/superpowers/ AI planning notes (nothing links to them) and added the folder to .gitignore.
  • README: the examples section now says the walk-forward script writes CSVs rather than a figure; the walk-forward paragraph reads as a sentence and matches the file's one-line paragraphs; dropped a CI trivia sentence and a repeated disclaimer; the roadmap now says what "execution lag" means (an engine option to fill after the signal close) so it no longer reads as contradicting the walk-forward example; replaced the one em dash in the tagline.
  • .gitignore now covers /prices.csv and /frontier.png, which the README's CLI examples write when run from the repository root.
  • CHANGELOG: added an Unreleased section for the walk-forward example and the release workflow. A compare of v0.1.0...main shows no src/ changes, so the package itself is unchanged.

Verification

  • Ran the CI steps locally: uv sync --locked --all-extras, ruff check, ruff format --check, mypy, and pytest --doctest-glob=README.md --cov=quantkit --cov-fail-under=90 (345 passed, 99.5% coverage).
  • CLI smoke commands and the three figure scripts run cleanly (figures restored afterwards).
  • Confirmed prices.csv, frontier.png and new files under docs/superpowers/ are ignored.

Generated by Claude Code

Delete docs/superpowers/ and ignore it. Clarify which examples make
figures, unwrap the walk-forward paragraph, drop CI trivia, explain
the roadmap's execution-lag item, ignore the README CLI outputs and
record the walk-forward example in an Unreleased changelog section.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016h2RvhZFj77hPxFn8TQUqq
@ult666666
ult666666 merged commit b6ed070 into main Oct 28, 2026
6 checks passed
@ult666666
ult666666 deleted the audit-fixes branch November 4, 2026 23:54
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.

2 participants