Skip to content

chore: declutter repo root (fold dev-tools, untrack .claude)#44

Merged
Guillain-RDCDE merged 1 commit into
mainfrom
chore/declutter-root
Jun 5, 2026
Merged

chore: declutter repo root (fold dev-tools, untrack .claude)#44
Guillain-RDCDE merged 1 commit into
mainfrom
chore/declutter-root

Conversation

@Guillain-RDCDE
Copy link
Copy Markdown
Owner

Landing on the repo, the root showed 11 folders + 11 files — several overlapping or not meant to be versioned. This tidies it to a conventional, self-explanatory layout (9 folders) without moving anything the Python/GitHub tooling needs at the root.

Before → after (root folders)

. github · assets · **dev-tools** · docker · docs · examples · ml · scripts · src · tests · **.claude**
.github · assets · docker · docs · examples · ml · scripts · src · tests

Changes

  • Untrack .claude/ (local Claude Code config) + gitignore it — it was never meant to be in the repo (the perennial "modified settings.local.json").
  • Dissolve dev-tools/, which duplicated examples/ and scripts/:
    • dev-tools/examples/*examples/ (incl. examples/repair/)
    • dev-tools/tools/scripts/tools/ (diagnostic utilities)
    • dev-tools/build-scripts/* + CODECOV_SETUP.mdscripts/
    • dev-tools/README.mddropped (it was stale — described files that no longer exist)
  • MANIFEST.in: drop the now-dead prune dev-tools.
  • scripts/README.md: document the absorbed tools/ subdir + build/CI helpers.

Why these and not others

Everything else at the root is mandatory by conventionpyproject.toml, README, LICENSE, CHANGELOG, CITATION, MANIFEST.in, the dotfiles (.flake8 can't move — flake8 doesn't read pyproject; .pre-commit-config, .readthedocs), and .github/src/tests/docs. assets/ stays at the root on purpose: the README banner uses an absolute …/main/assets/… URL that the already-published PyPI page renders — moving it would break that banner.

Safety

All moves are git renames (history preserved). No code touched. No references to the old paths remain anywhere (CI, pre-commit, pyproject, docs — all grepped clean). Local sanity tests pass; the required wheel-smoke gate will confirm packaging.

🤖 Generated with Claude Code

The root showed 11 folders, several of them overlapping or not meant to be in
the repo at all. Tidied to a conventional, self-explanatory layout (9 folders),
without touching anything packaging/tooling requires at the root.

- Untrack .claude/ (local Claude Code config) and gitignore it — it was never
  meant to be versioned (it's the perennial "modified settings.local.json").
- Dissolve dev-tools/ (which duplicated examples/ and scripts/):
  - dev-tools/examples/*        -> examples/        (incl. examples/repair/)
  - dev-tools/tools/            -> scripts/tools/    (diagnostic utilities)
  - dev-tools/build-scripts/*   -> scripts/          (build_package/test_coverage .bat)
  - dev-tools/CODECOV_SETUP.md  -> scripts/
  - dev-tools/README.md         -> dropped (was stale — described removed files)
- MANIFEST.in: drop the now-dead `prune dev-tools`.
- scripts/README.md: document the absorbed tools/ subdir + build/CI helpers.

All moves are git renames (history preserved). No code touched; no references to
the old paths remain (CI, pre-commit, pyproject, docs all clean). Tests pass.

Root is now: .github/ src/ tests/ docs/ examples/ ml/ docker/ scripts/ assets/
(assets/ stays — the README/PyPI banner depends on its absolute main URL).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Guillain-RDCDE Guillain-RDCDE merged commit c51279c into main Jun 5, 2026
16 checks passed
@Guillain-RDCDE Guillain-RDCDE deleted the chore/declutter-root branch June 5, 2026 09:30
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.

1 participant