|
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +## Project Rules |
| 4 | +- You will be assigned a designation number and the directory it is assigned to. |
| 5 | +- Only work in your designated directory. Every directory and file outside it is to be considered a black box that you cannot modify or access. |
| 6 | +- Boxes marked with X are jobs currently taken by other workers. Do not attempt to work on these jobs. |
| 7 | + |
| 8 | +## Jobs Available |
| 9 | + |
| 10 | +### Priority Jobs - Reconciliation/Worker Coordination |
| 11 | +- [ ] 1: (Last Updated 2025-07-04-17-45) **Reconcile documentation files in subdirectories with the main TODO, CHANGELOG, and README files.** |
| 12 | +- [ ] 2: (Ongoing) Ensure all directories have standardized, up-to-date documentation files (README.md, TODO.md, CHANGELOG.md, ARCHITECTURE.md). |
| 13 | + - Last updated: 2025-06-01 |
| 14 | +- [ ] 3: (Ongoing) Ensure all functions have corresponding tests. |
| 15 | +- [ ] 4: (Ongoing) Standardize all test files |
| 16 | +- [ ] 5: Integrate claudes_toolbox dataset tools into library |
| 17 | +- [ ] 6: Make claudes_toolbox dataset tools work with decentralized file system |
| 18 | +- [ ] 7: Make claudes_toolbox dataset tools work in a docker container |
| 19 | +- [ ] 8: Implement robustness tests for file system operations in `ipfs_datasets_py/pdf_processing/ |
| 20 | +- [ ] 9: Implement robustness tests for file system operations. |
| 21 | +- [x] 10: Split master_todo_list.md into separate TODO.md files for each subdirectory in ipfs_datasets_py except mcp_server - **COMPLETED on 7-4-2025** |
| 22 | + |
| 23 | +### Directory-Specific Jobs - Workers 61-75 (REVISED ASSIGNMENTS 2025-07-04) |
| 24 | +**NOTE**: After comprehensive documentation reconciliation, assignments changed from TDD implementation to testing existing implementations |
| 25 | +- [ ] 61: **TEST** existing implementations in utils/ directory (TextProcessor, ChunkOptimizer classes) |
| 26 | +- [ ] 62: **TEST** existing implementations in ipld/ directory (IPLDVectorStore, BlockFormatter classes) |
| 27 | +- [ ] 63: **TEST** existing implementations in vector_stores/ directory (FAISS, Elasticsearch, Qdrant stores) |
| 28 | +- [ ] 64: **TEST** existing implementations in rag/ directory (GraphRAG, dashboard implementations) |
| 29 | +- [ ] 65: **TEST** existing implementations in optimizers/ directory (ChunkOptimizer, PerformanceOptimizer) |
| 30 | +- [ ] 66: **TEST** existing implementations in embeddings/ directory (BaseComponent, embedding classes) |
| 31 | +- [x] 67: Complete TDD tasks for search/ directory - **COMPLETED 2024-07-04** |
| 32 | +- [ ] 68: **TEST** existing implementations in llm/ directory (LLMReasoningTracer, related classes) |
| 33 | +- [ ] 69: **TEST** existing implementations in multimedia/ directory (FFmpegVideoProcessor, MediaToolManager) |
| 34 | +- [ ] 70: **TEST** existing implementations in audit/ directory (SecurityProvenanceIntegrator class) |
| 35 | +- [ ] 71: **TEST** existing implementations in mcp_tools/ directory (MCP server tools, endpoints) |
| 36 | +- [ ] 72: **TEST** existing implementations in ipfs_embeddings_py/ directory (core embedding classes) |
| 37 | +- [ ] 73: **IMPLEMENT** wikipedia_x/ directory (confirmed minimal current implementation) |
| 38 | +- [ ] 74: **TEST** existing implementations in config/ directory (configuration management classes) |
| 39 | +- [ ] 75: **TEST** existing implementations in logic_integration/ directory (LogicProcessor, ReasoningCoordinator) |
| 40 | + |
| 41 | +### Test Standardization - Worker 130 |
| 42 | +- [x] 130: Standardize all test files to GIVEN WHEN THEN format - **COMPLETED 2025-07-04** |
| 43 | + |
| 44 | +### Test Implementation - Workers 130 - 140 |
| 45 | +- [ ] 131: Implement comprehensive test coverage for tests/ directory - **ASSIGNED 2025-07-04 - HIGH PRIORITY** |
| 46 | + - Fix monitoring module async loop issue affecting test_vector_store_tools.py |
| 47 | + - Implement actual test logic for all 10 main test files |
| 48 | + - Create test fixtures and data generators |
| 49 | + - Add integration tests for cross-module functionality |
| 50 | +- [ ] 132: Implement test coverage for top-level modules in ipfs_datasets_py (e.g., dataset_manager.py, config.py) |
| 51 | + - [ ] admin_dashboard (`ipfs_datasets_py/admin_dashboard.py`) (**Last Updated 2025-07-04**) |
| 52 | + - [ ] audit.py |
| 53 | + - [ ] car_conversion.py |
| 54 | + - [ ] config.py |
| 55 | + - [ ] dataset_manager.py |
| 56 | + |
| 57 | + |
| 58 | +- [ ] 345: Implement comprehensive test coverage for existing test files in tests/ directory: |
| 59 | + - [ ] `tests/test_admin_tools.py` |
| 60 | + - [ ] `tests/test_analysis_tools.py` |
| 61 | + - [ ] `tests/test_auth_tools.py` |
| 62 | + - [ ] `tests/test_background_task_tools.py` |
| 63 | + - [ ] `tests/test_cache_tools.py` |
| 64 | + - [ ] `tests/test_comprehensive_integration.py` |
| 65 | + - [ ] `tests/test_embedding_search_storage_tools.py` |
| 66 | + - [ ] `tests/test_embedding_tools.py` |
| 67 | + - [ ] `tests/test_fastapi_integration.py` |
| 68 | + - [ ] `tests/test_fio.py` |
| 69 | + - [ ] `tests/test_monitoring_tools.py` |
| 70 | + - [ ] `tests/test_test_e2e.py` |
| 71 | + - [ ] `tests/test_vector_store_tools.py` |
| 72 | + - [ ] `tests/test_vector_tools.py` |
| 73 | + - [ ] `tests/test_workflow_tools.py` |
| 74 | + - [ ] Test subdirectories: `tests/integration/`, `tests/unit/`, `tests/mcp/`, `tests/migration_tests/` |
| 75 | + |
| 76 | +- [ ] 554: Ensure that all functions and classes in ipfs are being imported by some sort of test file. |
| 77 | + |
| 78 | +### Adhoc Tools Development - Workers 76-85 |
| 79 | +- [ ] 76: Create project monitoring and analytics tools |
| 80 | +- [ ] 77: Develop automated testing and validation utilities |
| 81 | +- [ ] 78: Build dependency analysis and management tools |
| 82 | +- [ ] 79: Create performance benchmarking and profiling utilities |
| 83 | +- [ ] 80: Develop code quality and linting automation |
| 84 | +- [ ] 81: Build documentation generation and maintenance tools |
| 85 | +- [ ] 82: Create deployment and packaging utilities |
| 86 | +- [ ] 83: Develop security scanning and audit tools |
| 87 | +- [ ] 84: Build integration testing and CI/CD utilities |
| 88 | +- [ ] 85: Create project health monitoring and reporting tools |
| 89 | + |
| 90 | +### Tool Enhancement and Quality Assurance - Workers 160-175 |
| 91 | +- [ ] 160: Tool Enhancement - JSON configuration, monitoring tools, performance benchmarking |
| 92 | +- [ ] 175: Quality Assurance - Testing standards, validation workflows, security scanning |
| 93 | +- [ ] 175: Enforce testing standardization (TDD, GIVEN WHEN THEN, see `tests/_example_test_format.py` for format example) |
| 94 | +- [ ] 176: Validate test imports so that they compile without import errors. |
| 95 | +- [ ] 177: Ensure all public classes, functions, and methods have comprehensive docstrings (see `_example_docstring_format.md` for format example) - **ONGOING 2025-07-04** |
| 96 | + |
| 97 | +### Rules for All Jobs |
| 98 | +- Document all actions taken in your directory's CHANGELOG.md |
| 99 | +- Document all actions that need to be do be done in your directory's TODO.md |
| 100 | +- Document your software architecture decisions in your directory's ARCHITECTURE.md |
| 101 | +- Read the CHANGELOG.md and TODO.md files in your directory before starting work. If you cannot find one, ask for it before looking for it. |
| 102 | + |
| 103 | +### Coordination Guidelines |
| 104 | +- **Cross-Directory Dependencies**: Coordinate with other workers through project-level TODO.md, CHANGELOG.md, and CLAUDE.md files. |
| 105 | +- **Tool Standards**: All adhoc tools must use argparse and follow template in `adhoc_tools/README.md`. Adhoc tools are defined as tools that are created by workers as they work on their assigned directories, but might be useful to other workers in the future. They are not part of the main codebase, but are used to help workers complete their tasks. |
| 106 | +- **Progress Monitoring**: Use `python adhoc_tools/find_documentation.py` to track documentation status |
| 107 | +- **Completed Workers**: 67 (search/), 130 (tests/) - Available for coordination and integration tasks |
| 108 | + |
| 109 | + |
| 110 | +## Worker Assignment Summary |
| 111 | + |
| 112 | +### Completed Workers ✅ |
| 113 | +- **Worker 1**: Documentation reconciliation - **COMPLETED 2025-07-04** - Discovered and corrected massive documentation/code misalignment |
| 114 | +- **Worker 67**: search/ directory - Fixed syntax errors, implemented missing methods, created documentation |
| 115 | +- **Worker 130**: tests/ directory - Standardized test format, added import validation, created test structure |
| 116 | + |
| 117 | +### Critical Priority |
| 118 | +- **Worker 131**: tests/ directory - **HIGH PRIORITY** - Implement comprehensive test coverage, fix async loop issues, add fixtures |
| 119 | + |
| 120 | +### Revised Directory Workers (13 workers) - **FOCUS CHANGED TO TESTING EXISTING CODE** |
| 121 | +- **Workers 61-66**: utils/, ipld/, vector_stores/, rag/, optimizers/, embeddings/ - Test existing implementations |
| 122 | +- **Workers 68-72**: llm/, multimedia/, audit/, mcp_tools/, ipfs_embeddings_py/ - Test existing implementations |
| 123 | +- **Worker 73**: wikipedia_x/ - **IMPLEMENT** (only directory needing actual development) |
| 124 | +- **Workers 74-75**: config/, logic_integration/ - Test existing implementations |
| 125 | + |
| 126 | +### Active Tool Workers |
| 127 | +- **Workers 76-85**: Adhoc tools development (10 workers) |
| 128 | +- **Worker 160**: Tool enhancement and monitoring |
| 129 | +- **Worker 175**: Quality assurance and validation |
| 130 | + |
| 131 | +### Total Active Assignments: 27 workers |
| 132 | +- **Completed**: 4 workers (1, 67, 130, 177) |
| 133 | +- **Critical Priority**: 1 worker (131) |
| 134 | +- **Directory Testing**: 12 workers (61-66, 68-72, 74-75) |
| 135 | +- **Directory Implementation**: 1 worker (73 - wikipedia_x) |
| 136 | +- **Adhoc Tools**: 10 workers (76-85) |
| 137 | +- **Tool Enhancement/QA**: 2 workers (160, 175, 176) |
| 138 | + |
| 139 | +# Advice for All Workers |
| 140 | +Do what has been asked; nothing more, nothing less. |
| 141 | +NEVER create files unless they're absolutely necessary for achieving your goal. |
| 142 | +ALWAYS prefer editing an existing file to creating a new one. |
| 143 | +NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User. |
0 commit comments