Skip to content

Docs: README wording, CI badge and PR template - #8

Merged
akifkulll merged 3 commits into
mainfrom
docs/readme-fixes
Oct 23, 2026
Merged

akifkulll merged 3 commits into
mainfrom
docs/readme-fixes

Conversation

@akifkulll

Copy link
Copy Markdown
Collaborator

Small docs cleanup. No code changes.

Summary

  • README wording: "builds on top of it" suggested a dependency on scikit-learn, but there is none. The sentence now says the toolkit works alongside scikit-learn: blocks run inside scikit-learn pipelines, cross_val_score and GridSearchCV without depending on it.
  • CI badge: a badge for ci.yml, directly under the README title.
  • PR template: .github/PULL_REQUEST_TEMPLATE.md with these sections:
    • Closes #;
    • Summary;
    • How was it tested;
    • a checklist: ruff format/check, pytest, the block rules in CONTRIBUTING.md, and leakage + cross_val_score tests.

How was it tested

  • ruff check . and ruff format --check . (ruff 0.17.1): clean. This includes the README, because ruff checks code in Markdown files.
  • pytest: 32 passed, Python 3.13.5.

🤖 Generated with Claude Code

akifkulll and others added 2 commits October 17, 2026 16:11
The package works alongside scikit-learn without depending on it, which
the old "builds on top of it" wording contradicted.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sections: linked issue, summary, how it was tested, and a checklist for
ruff, pytest, the CONTRIBUTING block rules and leakage/cross_val_score tests.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@akifkulll
akifkulll merged commit 083cfce into main Oct 23, 2026
3 checks passed
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