Skip to content

DEPRECATED.md

Latest commit

 

History

History
221 lines (150 loc) · 7.37 KB

DEPRECATED.md

File metadata and controls

221 lines (150 loc) · 7.37 KB
Raw

Deprecated Files and Directory Changes

Date: 2025-11-21 Status: Repository reorganization completed Purpose: Document file relocations and deletions for improved project structure

Summary

This document tracks files that have been moved or removed from the root directory to improve project organization and maintainability. All changes preserve git history through git mv commands.

Files Moved to Better Locations

Documentation Files → docs/

Moved on: 2025-11-21

Original Location New Location Reason
IMPLEMENTATION_PLAN.md docs/IMPLEMENTATION_PLAN.md Architecture documentation belongs with other docs
TELEMETRY.md docs/TELEMETRY.md Technical documentation belongs with other docs
SECURITY_FIXES.md docs/SECURITY_FIXES.md Security documentation belongs with other docs

Impact: None - files still accessible, just better organized

Analysis/Research Files → research/

Moved on: 2025-11-21

Original Location New Location Reason
coordination_vs_bazinga_analysis.md research/coordination_vs_bazinga_analysis.md Analysis document belongs with 40+ other research docs
copilot_review_analysis.md research/copilot_review_analysis.md Analysis document belongs with other research docs
critical_gap_analysis.md research/critical_gap_analysis.md Analysis document belongs with other research docs
orchestrator_size_reduction_strategy.md research/orchestrator_size_reduction_strategy.md Strategy document belongs with other research docs
validation_report_output_improvements.md research/validation_report_output_improvements.md Analysis document belongs with other research docs
spec-kit-community-post.md research/spec-kit-community-post.md Community content belongs with research docs

Impact: None - files still accessible, consistent with existing research/ structure

Test Files → tests/

Moved on: 2025-11-21

Original Location New Location Reason
test_concurrent_access.py tests/test_concurrent_access.py Test files belong in tests/ directory
test_telemetry.py tests/test_telemetry.py Test files belong in tests/ directory
test_performance_comparison.py tests/test_performance_comparison.py Test files belong in tests/ directory

Impact: None - tests still runnable from standard location

Scripts → scripts/

Moved on: 2025-11-21

Original Location New Location Reason
validate_skills.py scripts/validate_skills.py Utility script belongs with other scripts

Impact: None - script still functional from scripts/ directory

Files Deleted

Old Test Reports

Deleted on: 2025-11-21

File Reason
test_validation_report.md Outdated test report, no longer needed
test_skills_enforcement.md Outdated test report, no longer needed

Impact: None - these were historical snapshots only

Directories Removed

Empty Directories

Removed on: 2025-11-21

Directory Reason
utils/ Empty directory (contained only __init__.py with no functionality)

Impact: None - directory had no functionality

Directories Preserved (No Changes)

Legacy Directories (Intentionally Kept)

The following directories were NOT removed despite appearing deprecated:

Directory Status Reason for Keeping
coordination/ Legacy but preserved May contain backwards compatibility needs, kept for now per maintainer decision
config/ Minimal but preserved Contains configuration files still in use, kept for now per maintainer decision

Note: These directories may be revisited in future cleanup efforts.

Root Directory Status

Files Remaining in Root (Correct)

These files should remain in the root directory:

  • README.md - Primary project documentation
  • CONTRIBUTING.md - Contributor guidelines (standard location)
  • LICENSE - License file (standard location)
  • .gitignore - Git configuration (must be in root)
  • pyproject.toml - Python build configuration (must be in root)
  • pytest.ini - Pytest configuration (standard location)
  • requirements-dev.txt - Development dependencies (standard location)
  • DEPRECATED.md - This file (documents reorganization history)

Updated Project Structure

bazinga/                          # Root
├── .claude/                      # Claude Code configuration
├── .github/                      # GitHub configuration
├── agents/                       # Agent definitions (packaged separately)
├── bazinga/                      # Runtime state (gitignored except templates/)
├── config/                       # ✅ KEPT - Configuration files
├── coordination/                 # ✅ KEPT - Legacy directory preserved
├── dashboard/                    # Dashboard UI
├── docs/                         # 📚 Documentation (EXPANDED +3 files)
├── examples/                     # Usage examples
├── research/                     # 📊 Research & Analysis (EXPANDED +6 files)
├── scripts/                      # 🔧 Scripts (EXPANDED +1 file)
├── src/                          # Source code
├── tests/                        # 🧪 Tests (EXPANDED +3 files)
├── .gitignore
├── CONTRIBUTING.md
├── DEPRECATED.md                 # ✅ NEW - This file
├── LICENSE
├── pytest.ini
├── pyproject.toml
├── README.md
└── requirements-dev.txt

Migration Guide

If You're Looking for a Moved File

  1. Check the tables above for the new location
  2. Use git history to track file movements: 
    git log --follow --all -- path/to/file.md
  3. File contents unchanged - only location changed

If You Have Open PRs or Branches

If you have branches with changes to moved files:

# Update your local branch
git fetch origin
git rebase origin/main

# Git will automatically track the moves
# Conflicts should be minimal as only locations changed

Rationale for Reorganization

Problems Addressed

  1. Root clutter - 22 files in root made it hard to find essential files
  2. Inconsistent organization - Similar files scattered across locations
  3. Poor discoverability - New contributors couldn't find related files
  4. Dead directories - Empty directories serving no purpose

Benefits Achieved

  1. ✅ Cleaner root - Only 8 essential files remain
  2. ✅ Logical grouping - Related files are together
  3. ✅ Easier navigation - Clear separation of concerns
  4. ✅ Better discoverability - New contributors can find things easily
  5. ✅ Maintains git history - All moves preserve file history
  6. ✅ Respects packaging - Follows pyproject.toml structure

Questions or Issues?

If you're having trouble finding a file or have questions about this reorganization:

  1. Check this document for the new location
  2. Search the repository: git grep "filename"
  3. Open an issue: https://github.com/mehdic/bazinga/issues

Last Updated: 2025-11-21 Approved By: Repository maintainer