chore: clean up repository root - #359
Conversation
Nothing in the build or repo uses webhint; the only reference was a descriptive line in context/knowledge/STACK.md, removed here too.
TESTING.md, PROFILE.md, REGISTRATION-GUARD.md, PUBLISH.md, and RELEASE-TESTING.md move to docs/; references updated in README.md, CLAUDE.md, and the release-integration-test command. CONFIG.md and MIGRATION.md stay at root deliberately — they are the most externally deep-linked docs (release notes, old PRs) and GitHub does not redirect moved files. CHANGELOG's historical mentions are left as written.
generate_changelog.py, test_generate_changelog.py, and requirements.txt move to scripts/; the generateAIChangelog Exec task and the context/knowledge docs point at the new paths. The script's CHANGELOG.md path is CWD-relative and the Gradle Exec task keeps the project root as working directory, so behavior is unchanged. Verified: 28 unittest tests OK from scripts/, gradle configuration parses.
IDE-generated config (dataSources.xml, dbnavigator.xml, module files) churns per machine and does not belong in the library repo; .idea/ is now gitignored. .vscode/ stays tracked deliberately.
Review: root directory cleanupReviewed the full diff (28 files, tiered into 5 commits). This is a clean, low-risk chore PR — no runtime/library code touched, only repo hygiene. Nice discipline splitting it into one logical commit per tier. Verified correctness of the moves:
Minor observations (non-blocking):
No bugs, security concerns, or performance issues found. LGTM. |
There was a problem hiding this comment.
Pull request overview
This PR cleans up the repository root by removing vestigial configs and IDE state, moving documentation into docs/, and relocating Python release tooling into scripts/ while updating references so release automation continues to work.
Changes:
- Moved release changelog generator + tests into
scripts/and updated the GradlegenerateAIChangelogExec task path. - Moved several markdown guides into
docs/and updated in-repo links/references accordingly. - Removed tracked IntelliJ
.idea/files and added common local artifacts (logs/,.idea/) to.gitignore.
Reviewed changes
Copilot reviewed 6 out of 28 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/test_generate_changelog.py | Unit tests for the changelog generator after moving tooling into scripts/. |
| scripts/requirements.txt | Pins Python dependency for AI-assisted changelog generation. |
| scripts/generate_changelog.py | Release changelog generator script relocated under scripts/. |
| README.md | Updates docs links to point at docs/ paths. |
| docs/TESTING.md | Testing guide moved under docs/. |
| docs/RELEASE-TESTING.md | Release integration testing runbook moved under docs/. |
| docs/REGISTRATION-GUARD.md | Registration Guard SPI guide moved under docs/. |
| docs/PUBLISH.md | Publishing guide moved under docs/. |
| docs/PROFILE.md | Profile extension guide moved under docs/. |
| context/knowledge/STACK.md | Updates internal knowledge references to new scripts/ and docs/ locations; removes .hintrc mention. |
| context/knowledge/README.md | Updates internal knowledge reference to scripts/generate_changelog.py. |
| CLAUDE.md | Updates documentation references to docs/ paths. |
| build.gradle | Updates generateAIChangelog task to run scripts/generate_changelog.py. |
| .idea/vcs.xml | Removes tracked IntelliJ project file. |
| .idea/uiDesigner.xml | Removes tracked IntelliJ UI designer palette file. |
| .idea/modules/user.main.iml | Removes tracked IntelliJ module file. |
| .idea/modules.xml | Removes tracked IntelliJ modules config. |
| .idea/misc.xml | Removes tracked IntelliJ misc project settings. |
| .idea/jarRepositories.xml | Removes tracked IntelliJ repository settings. |
| .idea/gradle.xml | Removes tracked IntelliJ Gradle project settings. |
| .idea/dbnavigator.xml | Removes tracked IntelliJ DB Navigator settings (includes local environment details). |
| .idea/dataSources.xml | Removes tracked IntelliJ datasource config (local-only state). |
| .idea/compiler.xml | Removes tracked IntelliJ compiler/annotation processing config. |
| .idea/.name | Removes tracked IntelliJ project name file. |
| .idea/.gitignore | Removes tracked IntelliJ internal ignore file. |
| .hintrc | Removes unused webhint config. |
| .gitignore | Adds logs/ and .idea/ to ignore local artifacts. |
| .claude/commands/release-integration-test.md | Updates command doc to reference docs/RELEASE-TESTING.md. |
Files not reviewed (12)
- .idea/.gitignore: Generated file
- .idea/.name: Generated file
- .idea/compiler.xml: Generated file
- .idea/dataSources.xml: Generated file
- .idea/dbnavigator.xml: Generated file
- .idea/gradle.xml: Generated file
- .idea/jarRepositories.xml: Generated file
- .idea/misc.xml: Generated file
- .idea/modules.xml: Generated file
- .idea/modules/user.main.iml: Generated file
- .idea/uiDesigner.xml: Generated file
- .idea/vcs.xml: Generated file
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Root directory cleanup, one commit per tier:
logs/and.idea/added to.gitignore; untrackedrepomix-output.txt,__pycache__/,bin/,logs/deleted locally..hintrc(webhint) removed — nothing uses it; its mention incontext/knowledge/STACK.mdremoved too.docs/:TESTING.md,PROFILE.md,REGISTRATION-GUARD.md,PUBLISH.md,RELEASE-TESTING.mdmoved; references updated inREADME.md,CLAUDE.md, and the/release-integration-testcommand.CONFIG.mdandMIGRATION.mdstay at root deliberately — they are the most externally deep-linked docs (release notes, old PRs) and GitHub does not redirect moved files. CHANGELOG's historical mentions untouched.scripts/:generate_changelog.py, its tests, andrequirements.txtmoved;generateAIChangelogtask path updated. The script'sCHANGELOG.mdpath is CWD-relative and the Exec task keeps project-root CWD, so behavior is unchanged. Verified: 28 unittest tests OK, gradle config parses, full build green..idea/untracked (11 files);.vscode/stays tracked deliberately.Root goes from 13 markdown files to 8, with no stray artifacts or tooling scripts at top level.