Skip to content

chore: clean up repository root - #359

Merged
devondragon merged 5 commits into
mainfrom
chore/root-cleanup
Aug 15, 2026
Merged

chore: clean up repository root#359
devondragon merged 5 commits into
mainfrom
chore/root-cleanup

Conversation

@devondragon

Copy link
Copy Markdown
Owner

Root directory cleanup, one commit per tier:

  1. Local artifacts: logs/ and .idea/ added to .gitignore; untracked repomix-output.txt, __pycache__/, bin/, logs/ deleted locally.
  2. Vestigial config: .hintrc (webhint) removed — nothing uses it; its mention in context/knowledge/STACK.md removed too.
  3. Docs → docs/: TESTING.md, PROFILE.md, REGISTRATION-GUARD.md, PUBLISH.md, RELEASE-TESTING.md moved; 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 untouched.
  4. Release tooling → scripts/: generate_changelog.py, its tests, and requirements.txt moved; generateAIChangelog task path updated. The script's CHANGELOG.md path 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.
  5. IDE state: .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.

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.
CopilotAI lite review requested due to automatic review settings August 15, 2026 05:13
@claude

claudeBot commented Aug 15, 2026

Copy link
Copy Markdown

Review: root directory cleanup

Reviewed 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:

  • build.gradle's generateAIChangelog Exec task path (scripts/generate_changelog.py) is correct, and the "CWD stays project-root" claim checks out — the script's CHANGELOG_FILE = "CHANGELOG.md" constant is CWD-relative (scripts/generate_changelog.py:55), and the Exec task doesn't set workingDir, so it still resolves to the root CHANGELOG.md.
  • All doc cross-references I could find were updated correctly: CLAUDE.md, README.md, .claude/commands/release-integration-test.md, context/knowledge/README.md, context/knowledge/STACK.md.
  • docs/PUBLISH.md's relative link to RELEASE-TESTING.md still resolves correctly since both files landed in docs/ together.
  • CONFIG.md, MIGRATION.md, CONTRIBUTING.md (left at root) don't link to any of the moved docs, so no dangling references there.
  • No leftover references to .hintrc/webhint or the old generate_changelog.py/requirements.txt root paths in .github/workflows/ or mise.toml.
  • .gitignore additions (logs/, .idea/) look right, and untracking .idea/* (11 files) is a good call — that's pure per-developer IDE state that shouldn't be shared.

Minor observations (non-blocking):

  • CONFIG.md and MIGRATION.md staying at root while everything else moves to docs/ is a reasonable judgment call given the external deep-link concern called out in the description — just flagging that the repo now has a slightly split doc layout (2 at root, 5 in docs/) for future contributors to be aware of. Might be worth a one-line note in CONTRIBUTING.md about where new docs should live going forward, but not required for this PR.
  • No test coverage changes needed here — this is a pure file-organization PR and the existing generate_changelog.py unit tests (28 passing, per the description) already validate the script still works from its new location.

No bugs, security concerns, or performance issues found. LGTM.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Gradle generateAIChangelog Exec 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
FileDescription
scripts/test_generate_changelog.pyUnit tests for the changelog generator after moving tooling into scripts/.
scripts/requirements.txtPins Python dependency for AI-assisted changelog generation.
scripts/generate_changelog.pyRelease changelog generator script relocated under scripts/.
README.mdUpdates docs links to point at docs/ paths.
docs/TESTING.mdTesting guide moved under docs/.
docs/RELEASE-TESTING.mdRelease integration testing runbook moved under docs/.
docs/REGISTRATION-GUARD.mdRegistration Guard SPI guide moved under docs/.
docs/PUBLISH.mdPublishing guide moved under docs/.
docs/PROFILE.mdProfile extension guide moved under docs/.
context/knowledge/STACK.mdUpdates internal knowledge references to new scripts/ and docs/ locations; removes .hintrc mention.
context/knowledge/README.mdUpdates internal knowledge reference to scripts/generate_changelog.py.
CLAUDE.mdUpdates documentation references to docs/ paths.
build.gradleUpdates generateAIChangelog task to run scripts/generate_changelog.py.
.idea/vcs.xmlRemoves tracked IntelliJ project file.
.idea/uiDesigner.xmlRemoves tracked IntelliJ UI designer palette file.
.idea/modules/user.main.imlRemoves tracked IntelliJ module file.
.idea/modules.xmlRemoves tracked IntelliJ modules config.
.idea/misc.xmlRemoves tracked IntelliJ misc project settings.
.idea/jarRepositories.xmlRemoves tracked IntelliJ repository settings.
.idea/gradle.xmlRemoves tracked IntelliJ Gradle project settings.
.idea/dbnavigator.xmlRemoves tracked IntelliJ DB Navigator settings (includes local environment details).
.idea/dataSources.xmlRemoves tracked IntelliJ datasource config (local-only state).
.idea/compiler.xmlRemoves tracked IntelliJ compiler/annotation processing config.
.idea/.nameRemoves tracked IntelliJ project name file.
.idea/.gitignoreRemoves tracked IntelliJ internal ignore file.
.hintrcRemoves unused webhint config.
.gitignoreAdds logs/ and .idea/ to ignore local artifacts.
.claude/commands/release-integration-test.mdUpdates 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.

@devondragon
devondragon merged commit 2242f92 into mainAug 15, 2026
5 checks passed
Sign up for freeto 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

@devondragon