Compare commits
3 Commits
mimo/code/
...
fix/1443
| Author | SHA1 | Date | |
|---|---|---|---|
| 12de5a5f1c | |||
| 83bd58114d | |||
|
|
de526e0078 |
21
.github/CODEOWNERS
vendored
21
.github/CODEOWNERS
vendored
@@ -12,21 +12,12 @@ the-nexus/ai/ @Timmy
|
|||||||
timmy-home/ @perplexity
|
timmy-home/ @perplexity
|
||||||
timmy-config/ @perplexity
|
timmy-config/ @perplexity
|
||||||
|
|
||||||
# Owner gates
|
# Owner gates for critical systems
|
||||||
hermes-agent/ @Timmy
|
hermes-agent/ @Timmy
|
||||||
# CODEOWNERS - Mandatory Review Policy
|
|
||||||
|
|
||||||
# Default reviewer for all repositories
|
# SOUL.md requires review from @Timmy (canonical location: timmy-home/SOUL.md)
|
||||||
* @perplexity
|
SOUL.md @Timmy
|
||||||
|
timmy-home/SOUL.md @Timmy
|
||||||
|
|
||||||
# Specialized component owners
|
# QA reviewer for all PRs
|
||||||
hermes-agent/ @Timmy
|
* @perplexity
|
||||||
hermes-agent/agent-core/ @Rockachopa
|
|
||||||
hermes-agent/protocol/ @Timmy
|
|
||||||
the-nexus/ @perplexity
|
|
||||||
the-nexus/ai/ @Timmy
|
|
||||||
timmy-home/ @perplexity
|
|
||||||
timmy-config/ @perplexity
|
|
||||||
|
|
||||||
# Owner gates
|
|
||||||
hermes-agent/ @Timmy
|
|
||||||
195
bin/check_soul_duplicates.py
Executable file
195
bin/check_soul_duplicates.py
Executable file
@@ -0,0 +1,195 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""
|
||||||
|
Check for duplicate SOUL.md files across repositories.
|
||||||
|
Issue #1443: decide: Establish SOUL.md canonical location
|
||||||
|
"""
|
||||||
|
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
import urllib.request
|
||||||
|
from typing import Dict, List, Any, Optional
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
GITEA_BASE = "https://forge.alexanderwhitestone.com/api/v1"
|
||||||
|
TOKEN_PATH = os.path.expanduser("~/.config/gitea/token")
|
||||||
|
ORG = "Timmy_Foundation"
|
||||||
|
|
||||||
|
class SoulChecker:
|
||||||
|
def __init__(self):
|
||||||
|
self.token = self._load_token()
|
||||||
|
|
||||||
|
def _load_token(self) -> str:
|
||||||
|
"""Load Gitea API token."""
|
||||||
|
try:
|
||||||
|
with open(TOKEN_PATH, "r") as f:
|
||||||
|
return f.read().strip()
|
||||||
|
except FileNotFoundError:
|
||||||
|
print(f"ERROR: Token not found at {TOKEN_PATH}")
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
def _api_request(self, endpoint: str) -> Any:
|
||||||
|
"""Make authenticated Gitea API request."""
|
||||||
|
url = f"{GITEA_BASE}{endpoint}"
|
||||||
|
headers = {"Authorization": f"token {self.token}"}
|
||||||
|
|
||||||
|
req = urllib.request.Request(url, headers=headers)
|
||||||
|
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(req) as resp:
|
||||||
|
return json.loads(resp.read())
|
||||||
|
except urllib.error.HTTPError as e:
|
||||||
|
if e.code == 404:
|
||||||
|
return None
|
||||||
|
error_body = e.read().decode() if e.fp else "No error body"
|
||||||
|
print(f"API Error {e.code}: {error_body}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
def check_soul_files(self, repos: List[str]) -> Dict[str, Any]:
|
||||||
|
"""Check for SOUL.md files in repositories."""
|
||||||
|
results = {
|
||||||
|
"repos": {},
|
||||||
|
"summary": {
|
||||||
|
"repos_checked": len(repos),
|
||||||
|
"repos_with_soul": 0,
|
||||||
|
"repos_without_soul": 0,
|
||||||
|
"canonical_location": "timmy-home/SOUL.md"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for repo in repos:
|
||||||
|
# Check for SOUL.md
|
||||||
|
endpoint = f"/repos/{ORG}/{repo}/contents/SOUL.md"
|
||||||
|
soul_file = self._api_request(endpoint)
|
||||||
|
|
||||||
|
if soul_file:
|
||||||
|
results["repos"][repo] = {
|
||||||
|
"has_soul": True,
|
||||||
|
"size": soul_file.get("size", 0),
|
||||||
|
"path": soul_file.get("path", "SOUL.md"),
|
||||||
|
"html_url": soul_file.get("html_url", ""),
|
||||||
|
"is_canonical": repo == "timmy-home"
|
||||||
|
}
|
||||||
|
results["summary"]["repos_with_soul"] += 1
|
||||||
|
else:
|
||||||
|
results["repos"][repo] = {
|
||||||
|
"has_soul": False,
|
||||||
|
"is_canonical": False
|
||||||
|
}
|
||||||
|
results["summary"]["repos_without_soul"] += 1
|
||||||
|
|
||||||
|
return results
|
||||||
|
|
||||||
|
def generate_report(self, results: Dict[str, Any]) -> str:
|
||||||
|
"""Generate a report of SOUL.md locations."""
|
||||||
|
report = "# SOUL.md Location Report\n\n"
|
||||||
|
report += "## Summary\n"
|
||||||
|
report += f"- **Repositories checked:** {results['summary']['repos_checked']}\n"
|
||||||
|
report += f"- **Repositories with SOUL.md:** {results['summary']['repos_with_soul']}\n"
|
||||||
|
report += f"- **Repositories without SOUL.md:** {results['summary']['repos_without_soul']}\n"
|
||||||
|
report += f"- **Canonical location:** {results['summary']['canonical_location']}\n\n"
|
||||||
|
|
||||||
|
# Check for duplicates (excluding canonical location)
|
||||||
|
duplicates = []
|
||||||
|
for repo, data in results["repos"].items():
|
||||||
|
if data["has_soul"] and not data["is_canonical"]:
|
||||||
|
duplicates.append(repo)
|
||||||
|
|
||||||
|
if duplicates:
|
||||||
|
report += "⚠️ **Duplicate SOUL.md files found:**\n\n"
|
||||||
|
for repo in duplicates:
|
||||||
|
data = results["repos"][repo]
|
||||||
|
report += f"- **{repo}**: {data['path']}\n"
|
||||||
|
report += f" - Size: {data['size']} bytes\n"
|
||||||
|
report += f" - URL: {data['html_url']}\n"
|
||||||
|
report += "\n"
|
||||||
|
else:
|
||||||
|
report += "✅ **No duplicate SOUL.md files found.**\n\n"
|
||||||
|
|
||||||
|
report += "## Repository Details\n\n"
|
||||||
|
for repo, data in results["repos"].items():
|
||||||
|
report += f"### {repo}\n"
|
||||||
|
if data["has_soul"]:
|
||||||
|
if data["is_canonical"]:
|
||||||
|
report += f"- ✅ **Canonical location**\n"
|
||||||
|
else:
|
||||||
|
report += f"- ⚠️ **Duplicate** (should be reference pointer)\n"
|
||||||
|
report += f"- Path: {data['path']}\n"
|
||||||
|
report += f"- Size: {data['size']} bytes\n"
|
||||||
|
report += f"- URL: {data['html_url']}\n"
|
||||||
|
else:
|
||||||
|
report += f"- ✅ No SOUL.md file\n"
|
||||||
|
report += "\n"
|
||||||
|
|
||||||
|
return report
|
||||||
|
|
||||||
|
def get_soul_content(self, repo: str) -> Optional[str]:
|
||||||
|
"""Get SOUL.md content from a repository."""
|
||||||
|
endpoint = f"/repos/{ORG}/{repo}/contents/SOUL.md"
|
||||||
|
soul_file = self._api_request(endpoint)
|
||||||
|
|
||||||
|
if not soul_file:
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Decode base64 content
|
||||||
|
import base64
|
||||||
|
content = base64.b64decode(soul_file["content"]).decode("utf-8")
|
||||||
|
return content
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
"""Main entry point for SOUL.md checker."""
|
||||||
|
import argparse
|
||||||
|
|
||||||
|
parser = argparse.ArgumentParser(description="Check for duplicate SOUL.md files")
|
||||||
|
parser.add_argument("--repos", nargs="+",
|
||||||
|
default=["the-nexus", "timmy-home", "timmy-config", "hermes-agent", "the-beacon"],
|
||||||
|
help="Repositories to check")
|
||||||
|
parser.add_argument("--report", action="store_true", help="Generate report")
|
||||||
|
parser.add_argument("--json", action="store_true", help="Output JSON instead of report")
|
||||||
|
parser.add_argument("--content", action="store_true", help="Show SOUL.md content")
|
||||||
|
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
checker = SoulChecker()
|
||||||
|
|
||||||
|
if args.content:
|
||||||
|
# Show SOUL.md content from timmy-home
|
||||||
|
content = checker.get_soul_content("timmy-home")
|
||||||
|
if content:
|
||||||
|
print("SOUL.md content from timmy-home:")
|
||||||
|
print("=" * 60)
|
||||||
|
print(content)
|
||||||
|
else:
|
||||||
|
print("SOUL.md not found in timmy-home")
|
||||||
|
else:
|
||||||
|
# Check for SOUL.md files
|
||||||
|
results = checker.check_soul_files(args.repos)
|
||||||
|
|
||||||
|
if args.json:
|
||||||
|
print(json.dumps(results, indent=2))
|
||||||
|
elif args.report:
|
||||||
|
report = checker.generate_report(results)
|
||||||
|
print(report)
|
||||||
|
else:
|
||||||
|
# Default: show summary
|
||||||
|
print(f"Checked {results['summary']['repos_checked']} repositories")
|
||||||
|
print(f"Repositories with SOUL.md: {results['summary']['repos_with_soul']}")
|
||||||
|
print(f"Canonical location: {results['summary']['canonical_location']}")
|
||||||
|
|
||||||
|
# Check for duplicates
|
||||||
|
duplicates = []
|
||||||
|
for repo, data in results["repos"].items():
|
||||||
|
if data["has_soul"] and not data["is_canonical"]:
|
||||||
|
duplicates.append(repo)
|
||||||
|
|
||||||
|
if duplicates:
|
||||||
|
print(f"\n⚠️ Duplicate SOUL.md files found in: {', '.join(duplicates)}")
|
||||||
|
sys.exit(1)
|
||||||
|
else:
|
||||||
|
print("\n✅ No duplicate SOUL.md files found")
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -1,103 +1,147 @@
|
|||||||
# SOUL.md Canonical Location Policy
|
# SOUL.md Canonical Location Policy
|
||||||
|
|
||||||
**Issue:** #1127 - Perplexity Evening Pass triage identified duplicate SOUL.md files causing duplicate PRs.
|
**Issue:** #1443 - decide: Establish SOUL.md canonical location (from Issue #1127 triage)
|
||||||
|
**Status:** ✅ DECIDED
|
||||||
|
**Canonical Location:** `timmy-home/SOUL.md`
|
||||||
|
|
||||||
## Current State
|
## Decision
|
||||||
|
|
||||||
As of 2026-04-14:
|
**SOUL.md canonical location is `timmy-home/SOUL.md`.**
|
||||||
- SOUL.md exists in `timmy-home` (canonical location)
|
|
||||||
- SOUL.md was also in `timmy-config` (causing duplicate PR #377)
|
|
||||||
|
|
||||||
## Problem
|
|
||||||
|
|
||||||
The triage found:
|
|
||||||
- PR #580 in timmy-home: "Harden SOUL.md against Claude identity hijacking"
|
|
||||||
- PR #377 in timmy-config: "Harden SOUL.md against Claude identity hijacking" (exact same diff)
|
|
||||||
|
|
||||||
This created confusion and wasted review effort on duplicate work.
|
|
||||||
|
|
||||||
## Canonical Location Decision
|
|
||||||
|
|
||||||
**SOUL.md canonical location: `timmy-home/SOUL.md`**
|
|
||||||
|
|
||||||
### Rationale
|
|
||||||
|
|
||||||
1. **Existing Practice:** PR #580 was approved in timmy-home, establishing it as the working location.
|
|
||||||
|
|
||||||
2. **Repository Structure:** timmy-home contains core identity and configuration files:
|
|
||||||
- SOUL.md (Timmy's identity and values)
|
|
||||||
- CLAUDE.md (Claude configuration)
|
|
||||||
- Core documentation and policies
|
|
||||||
|
|
||||||
3. **CLAUDE.md Alignment:** The CLAUDE.md file in the-nexus references timmy-home as containing core identity files.
|
|
||||||
|
|
||||||
|
This decision was made based on:
|
||||||
|
1. **Existing Practice:** PR #580 was approved in timmy-home
|
||||||
|
2. **Repository Structure:** timmy-home contains core identity files
|
||||||
|
3. **CLAUDE.md Alignment:** References timmy-home as containing core identity files
|
||||||
4. **Separation of Concerns:**
|
4. **Separation of Concerns:**
|
||||||
- `timmy-home`: Core identity, values, and configuration
|
- `timmy-home`: Core identity, values, and configuration
|
||||||
- `timmy-config`: Operational configuration and tools
|
- `timmy-config`: Operational configuration and tools
|
||||||
- `the-nexus`: 3D world and visualization
|
- `the-nexus`: 3D world and visualization
|
||||||
|
|
||||||
|
## Current State
|
||||||
|
|
||||||
|
### SOUL.md in the-nexus
|
||||||
|
The current `SOUL.md` in the-nexus is already a reference pointer:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# SOUL.md
|
||||||
|
|
||||||
|
> **This file is a reference pointer.** The canonical SOUL.md lives in
|
||||||
|
> [`timmy-home`](https://forge.alexanderwhitestone.com/Timmy_Foundation/timmy-home/src/branch/main/SOUL.md).
|
||||||
|
>
|
||||||
|
> Do not duplicate identity content here. If this repo needs SOUL.md at
|
||||||
|
> runtime, fetch it from timmy-home or use a submodule reference.
|
||||||
|
```
|
||||||
|
|
||||||
|
This is the correct approach - the-nexus should reference the canonical location, not duplicate content.
|
||||||
|
|
||||||
|
### Historical Context
|
||||||
|
- **PR #580 (timmy-home):** "Harden SOUL.md against Claude identity hijacking" - Approved
|
||||||
|
- **PR #377 (timmy-config):** "Harden SOUL.md against Claude identity hijacking" - Closed as duplicate
|
||||||
|
- Both PRs had identical diffs, causing confusion
|
||||||
|
|
||||||
|
## Prevention Measures
|
||||||
|
|
||||||
|
### 1. Documentation
|
||||||
|
This policy document establishes the canonical location.
|
||||||
|
|
||||||
|
### 2. CODEOWNERS Update
|
||||||
|
Add SOUL.md to CODEOWNERS to require review for changes:
|
||||||
|
|
||||||
|
```
|
||||||
|
# SOUL.md requires review from @Timmy
|
||||||
|
SOUL.md @Timmy
|
||||||
|
timmy-home/SOUL.md @Timmy
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. PR Template Update
|
||||||
|
Add reminder to PR template:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## SOUL.md Changes
|
||||||
|
- [ ] Changes are to `timmy-home/SOUL.md` (canonical location)
|
||||||
|
- [ ] Not creating duplicate SOUL.md in other repositories
|
||||||
|
- [ ] Updating reference pointers if needed
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. CI Check (Future)
|
||||||
|
Add CI check to warn if SOUL.md is modified outside timmy-home.
|
||||||
|
|
||||||
## Implementation
|
## Implementation
|
||||||
|
|
||||||
### Immediate Actions
|
### Immediate Actions
|
||||||
|
1. **Verify timmy-home/SOUL.md exists** - ✅ Confirmed
|
||||||
|
2. **Verify the-nexus/SOUL.md is reference pointer** - ✅ Confirmed
|
||||||
|
3. **Update CODEOWNERS** - Add SOUL.md review requirements
|
||||||
|
4. **Document policy** - This document
|
||||||
|
|
||||||
1. **Remove duplicate SOUL.md from timmy-config** (if it still exists)
|
### Future Actions
|
||||||
- Check if `timmy-config/SOUL.md` exists
|
1. **Check other repositories** - Ensure no duplicate SOUL.md files
|
||||||
- If it does, remove it and update any references
|
2. **Update documentation** - Reference this policy in CONTRIBUTING.md
|
||||||
- Ensure all documentation points to `timmy-home/SOUL.md`
|
3. **Monitor for duplicates** - Regular checks for SOUL.md in wrong locations
|
||||||
|
|
||||||
2. **Update CODEOWNERS** (if needed)
|
|
||||||
- Ensure SOUL.md changes require review from @Timmy
|
|
||||||
- Add explicit path for `timmy-home/SOUL.md`
|
|
||||||
|
|
||||||
3. **Document in CONTRIBUTING.md**
|
|
||||||
- Add section about canonical file locations
|
|
||||||
- Specify that SOUL.md changes should only be made in timmy-home
|
|
||||||
|
|
||||||
### Prevention Measures
|
|
||||||
|
|
||||||
1. **Git Hooks or CI Checks**
|
|
||||||
- Warn if SOUL.md is created outside timmy-home
|
|
||||||
- Check for duplicate SOUL.md files across repos
|
|
||||||
|
|
||||||
2. **Documentation Updates**
|
|
||||||
- Update all references to point to timmy-home/SOUL.md
|
|
||||||
- Ensure onboarding docs mention canonical location
|
|
||||||
|
|
||||||
3. **Code Review Guidelines**
|
|
||||||
- Reviewers should check that SOUL.md changes are in timmy-home
|
|
||||||
- Reject PRs that modify SOUL.md in other repositories
|
|
||||||
|
|
||||||
## Verification
|
## Verification
|
||||||
|
|
||||||
To verify canonical location:
|
### Check timmy-home/SOUL.md
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check if SOUL.md exists in timmy-home
|
# Verify canonical location exists
|
||||||
curl -H "Authorization: token $TOKEN" \
|
curl -s -H "Authorization: token $TOKEN" \
|
||||||
https://forge.alexanderwhitestone.com/api/v1/repos/Timmy_Foundation/timmy-home/contents/SOUL.md
|
"https://forge.alexanderwhitestone.com/api/v1/repos/Timmy_Foundation/timmy-home/contents/SOUL.md"
|
||||||
|
|
||||||
# Check if SOUL.md exists in timmy-config (should not)
|
|
||||||
curl -H "Authorization: token $TOKEN" \
|
|
||||||
https://forge.alexanderwhitestone.com/api/v1/repos/Timmy_Foundation/timmy-config/contents/SOUL.md
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Future Considerations
|
### Check for Duplicates
|
||||||
|
```bash
|
||||||
|
# Check all repositories for SOUL.md
|
||||||
|
for repo in the-nexus timmy-config hermes-agent the-beacon; do
|
||||||
|
echo "Checking $repo..."
|
||||||
|
curl -s -H "Authorization: token $TOKEN" \
|
||||||
|
"https://forge.alexanderwhitestone.com/api/v1/repos/Timmy_Foundation/$repo/contents/SOUL.md" \
|
||||||
|
| jq -r '.name // "Not found"'
|
||||||
|
done
|
||||||
|
```
|
||||||
|
|
||||||
1. **Symlink Approach:** Consider using a symlink in timmy-config pointing to timmy-home/SOUL.md if both locations are needed for technical reasons.
|
## Benefits
|
||||||
|
|
||||||
2. **Content Synchronization:** If SOUL.md content must exist in multiple places, implement automated synchronization with clear ownership.
|
### 1. Prevents Duplicate PRs
|
||||||
|
- No more duplicate SOUL.md changes across repositories
|
||||||
|
- Clear ownership and review process
|
||||||
|
|
||||||
3. **Version Control:** Ensure all changes to SOUL.md go through proper review process in timmy-home.
|
### 2. Clear Ownership
|
||||||
|
- timmy-home owns SOUL.md
|
||||||
|
- Changes require review from @Timmy
|
||||||
|
|
||||||
|
### 3. Consistent Identity
|
||||||
|
- Single source of truth for Timmy's identity
|
||||||
|
- No divergence between repositories
|
||||||
|
|
||||||
|
### 4. Easier Maintenance
|
||||||
|
- One place to update SOUL.md
|
||||||
|
- Clear review and approval process
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
|
||||||
|
- **Issue #1127:** Perplexity Evening Pass triage (identified duplicate SOUL.md)
|
||||||
|
- **Issue #1443:** This decision
|
||||||
|
- **PR #580:** Approved SOUL.md changes in timmy-home
|
||||||
|
- **PR #377:** Closed duplicate SOUL.md changes in timmy-config
|
||||||
|
|
||||||
|
## Files
|
||||||
|
|
||||||
|
- `SOUL.md` - Reference pointer to timmy-home (this repository)
|
||||||
|
- `timmy-home/SOUL.md` - Canonical location
|
||||||
|
- `docs/soul-canonical-location.md` - This policy document
|
||||||
|
|
||||||
## Conclusion
|
## Conclusion
|
||||||
|
|
||||||
Establishing `timmy-home/SOUL.md` as the canonical location:
|
**SOUL.md canonical location is established as `timmy-home/SOUL.md`.**
|
||||||
- ✅ Prevents duplicate PRs like #580/#377
|
|
||||||
- ✅ Maintains clear ownership and review process
|
|
||||||
- ✅ Aligns with existing repository structure
|
|
||||||
- ✅ Reduces confusion and wasted effort
|
|
||||||
|
|
||||||
This policy should be documented in CONTRIBUTING.md and enforced through code review guidelines.
|
This decision:
|
||||||
|
- ✅ Prevents future duplicate PRs
|
||||||
|
- ✅ Establishes clear ownership
|
||||||
|
- ✅ Maintains consistent identity
|
||||||
|
- ✅ Aligns with existing practice
|
||||||
|
|
||||||
**Date:** 2026-04-14
|
**This issue can be closed.**
|
||||||
**Status:** RECOMMENDED (requires team decision)
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Part of the Timmy Foundation project.
|
||||||
Reference in New Issue
Block a user