CLEANUP 2026 01 31 - nself-org/cli GitHub Wiki
Date: January 31, 2026 Purpose: Clean up repository structure and improve organization
This cleanup operation reorganized the nself repository to maintain a professional structure, remove clutter, and prevent future accumulation of temporary files.
Moved temporary working documents from root directory to appropriate docs/ subdirectories:
Audit Documents โ docs/audits/:
- AUDIT-FINDINGS-SUMMARY.md
- AUDIT-INDEX.md
- GITHUB-ISSUES-TO-CREATE.md
- QUICK-START-ISSUES.md
Development Documents โ docs/development/:
- DOCS-SYNTAX-UPDATES.md
- DOCS-UPDATE-SUMMARY.md
- ERROR-HANDLING-ADDITIONS.md
- ERROR-HANDLING-COMPLETE.md
- ERROR-HANDLING-VERIFICATION.md
- IMPLEMENTATION-SUMMARY.md
Feature Documents โ docs/features/:
- FEATURE-CHECKLIST.md
Security Documents โ docs/security/:
- SECURITY-FIX-REPORT.md
Testing Documents โ docs/testing/:
- TEST-COMPATIBILITY-FIXES.md
Deleted directories that should not be in version control (already gitignored):
-
_backup/- Backup directories from nself reset operations (~12KB) -
.environments/- Test environment configurations.environments/test-prod/server.json.environments/test-staging/server.json
Removed log files from source directory:
src/.nself/billing/billing.log
Updated .gitignore with improved patterns to prevent future clutter:
Added Runtime Directories:
# Runtime directories
.nself/
.environments/Added Working Document Patterns:
# Working documents (should be moved to docs/ before commit)
*-SUMMARY.md
*-INDEX.md
*-UPDATES.md
*-ADDITIONS.md
*-COMPLETE.md
*-VERIFICATION.md
*-CHECKLIST.md
*-ISSUES.md
*-REPORT.md
*-FIXES.mdCleaned up duplicates:
- Consolidated project config directory entries (was listed twice)
- Removed duplicate
.envpatterns
Added structured documentation indices:
-
docs/architecture/INDEX.md- Architecture documentation index -
docs/infrastructure/INDEX.md- Infrastructure documentation index -
docs/infrastructure/README.md- Infrastructure overview
Added .gitleaksignore for managing secret scanning exceptions.
/
โโโ AUDIT-FINDINGS-SUMMARY.md # 13 temporary working docs in root
โโโ AUDIT-INDEX.md
โโโ DOCS-SYNTAX-UPDATES.md
โโโ DOCS-UPDATE-SUMMARY.md
โโโ ERROR-HANDLING-ADDITIONS.md
โโโ ERROR-HANDLING-COMPLETE.md
โโโ ERROR-HANDLING-VERIFICATION.md
โโโ FEATURE-CHECKLIST.md
โโโ GITHUB-ISSUES-TO-CREATE.md
โโโ IMPLEMENTATION-SUMMARY.md
โโโ QUICK-START-ISSUES.md
โโโ SECURITY-FIX-REPORT.md
โโโ TEST-COMPATIBILITY-FIXES.md
โโโ _backup/ # Runtime directories
โโโ .environments/
โโโ .gitignore # Had duplicates, incomplete patterns
โโโ ...
/
โโโ README.md # Only essential files in root
โโโ LICENSE
โโโ install.sh
โโโ nself
โโโ .gitignore # Enhanced with better patterns
โโโ .gitleaksignore # Security scanning config
โโโ docs/
โ โโโ audits/ # All audit docs organized
โ โโโ development/ # All dev docs organized
โ โโโ features/ # Feature docs
โ โโโ security/ # Security docs
โ โโโ testing/ # Testing docs
โ โโโ architecture/ # New: Architecture index
โ โโโ infrastructure/ # New: Infrastructure index
โโโ src/
โโโ bin/
โโโ examples/
โโโ scripts/
- Moved: 13 working documents
- Deleted: 3 runtime files/directories
- Modified: 1 file (.gitignore)
- Added: 4 files (indices and security config)
-
Cleaner Root Directory
- Only essential files remain in root
- Professional first impression for new contributors
-
Better Organization
- Documents categorized by purpose (audits, development, features, security, testing)
- Easier to find relevant information
-
Prevention
- Enhanced .gitignore prevents future temporary file commits
- Pattern-based ignoring catches similar files automatically
-
Maintainability
- Clear structure for where documents belong
- Runtime directories automatically ignored
-
Git History
- Files moved (not deleted/recreated), preserving history
- Clean separation of concerns
Only these types of files should be in root:
- README.md
- LICENSE
- install.sh
- nself (main CLI entry point)
- .gitignore, .gitattributes
- .github/ directory
- Essential config files (.semgrepignore, .gitleaksignore)
All working documents should be placed in docs/ subdirectories:
- Audits โ
docs/audits/ - Development notes โ
docs/development/ - Feature planning โ
docs/features/ - Security reports โ
docs/security/ - Testing reports โ
docs/testing/
The following are automatically ignored and should never be committed:
-
_backup*directories -
.nself/runtime directory -
.environments/test configurations -
*-SUMMARY.md,*-REPORT.md, etc. (unless in docs/) - Log files (
*.log)
After cleanup:
# Root directory now contains only essential files
$ ls -1 *.md
README.md
# Working documents properly organized
$ ls docs/audits/ docs/development/ docs/features/ docs/security/ docs/testing/
docs/audits/:
AUDIT-FINDINGS-SUMMARY.md GITHUB-ISSUES-TO-CREATE.md
AUDIT-INDEX.md QUICK-START-ISSUES.md
docs/development/:
DOCS-SYNTAX-UPDATES.md ERROR-HANDLING-VERIFICATION.md
DOCS-UPDATE-SUMMARY.md IMPLEMENTATION-SUMMARY.md
ERROR-HANDLING-ADDITIONS.md
ERROR-HANDLING-COMPLETE.md
docs/features/:
FEATURE-CHECKLIST.md
docs/security/:
SECURITY-FIX-REPORT.md
docs/testing/:
TEST-COMPATIBILITY-FIXES.md
# No runtime directories in git
$ git ls-files | grep -E "^(_backup|\.environments)"
# (no results - correct)chore: clean up repository structure and improve organization
- Move 13 working documents from root to appropriate docs/ subdirectories
- Remove runtime directories (_backup/, .environments/) from tracking
- Clean up log files from src directory
- Enhance .gitignore with better patterns for future prevention
- Add documentation indices for architecture and infrastructure
- Add .gitleaksignore for security scanning configuration
- Consolidate duplicate .gitignore entries
Benefits:
- Cleaner, more professional root directory
- Better document organization by category
- Prevention of future temporary file commits
- Improved maintainability and navigation
This cleanup addresses:
- Repository organization best practices
- Prevention of CI issues from temporary files
- Improved contributor experience
- Professional project presentation
- โ Commit these changes
- Consider creating a CONTRIBUTING.md with structure guidelines
- Add pre-commit hook to prevent root directory clutter
- Document the docs/ subdirectory structure in main README
Status: Complete Files Modified: 18 total (13 moved, 1 modified, 4 added) Repository Size Impact: Negligible (reorganization only) Breaking Changes: None (all moves preserve git history)