OpenWriterControle/docs/github/GITHUB_SETTINGS.md
Darren Hinde bf02ad0d5c
refactor: Rename repository to OpenAgents Control (#100)
* refactor: Rename repository to OpenAgents Control

Update all project references from "OpenAgents" to "OpenAgents Control":
- Updated core config files (package.json, registry.json)
- Updated documentation (README.md, docs/)
- Updated scripts (install.sh, update.sh, test scripts)
- Updated agent and command files
- Updated integrations and packages
- Updated all GitHub URLs to use OpenAgentsControl

Naming convention:
- Display name: "OpenAgents Control"
- Repository URL: OpenAgentsControl

* feat: Enable subagent-to-subagent delegation (ContextScout integration)

Allow coding-related subagents to call ContextScout for context discovery:
- CoderAgent: Can now discover coding standards on-demand
- TestEngineer: Can now discover test coverage and TDD guidelines
- CodeReviewer: Can now discover code review and security patterns
- BuildAgent: Can now discover build validation standards
- DocWriter: Can now discover documentation formatting guidelines

Changes per subagent:
- Added `task: true` to tools section
- Added permission allowlist for ContextScout only (deny all other delegation)
- Added Context Discovery workflow section with when-to-call guidance

This enables subagents to be self-sufficient for finding relevant standards
instead of relying on orchestrator to provide all context files.

Benefits:
- Subagents can discover what they need when context isn't explicit
- Maintains security (only ContextScout allowed via task tool)
- Follows existing patterns (uses task tool like main agents)

* fix: Set OPENCODE_BRANCH in CI tests to use PR branch for downloads

- Add OPENCODE_BRANCH environment variable to E2E tests
- Add OPENCODE_BRANCH environment variable to profile smoke tests
- Ensures tests download files from the PR branch instead of main
- Fixes E2E test failures after repository rename to OpenAgentsControl
2026-01-18 09:31:35 +00:00

117 lines
3.1 KiB
Markdown

# GitHub Repository Settings Checklist
After merging this PR, update these GitHub repository settings:
## 1. About Section
**Current:** (needs update)
**New Description:**
```
AI agent framework for plan-first development workflows with approval-based execution. Multi-language support (TypeScript, Python, Go, Rust) with automatic testing, code review, and validation.
```
**Website:** `https://github.com/darrenhinde/OpenAgentsControl`
## 2. Topics (Add All 16)
Go to: Settings → General → Topics
**Must-Have Topics (10):**
- `ai-agents`
- `code-generation`
- `developer-tools`
- `llm`
- `typescript`
- `python`
- `automation`
- `testing`
- `opencode`
- `workflow`
**Nice-to-Have Topics (6):**
- `prompt-engineering`
- `go`
- `rust`
- `code-validation`
- `context-aware`
- `multi-language`
## 3. Social Preview Image
Go to: Settings → General → Social Preview
**Action:** Upload a 1280x640px image showing:
- Repository name
- Tagline: "Plan-First AI Development Framework"
- Key features icons (agents, testing, validation)
- Your branding
**Quick Option:** Use Canva or similar to create from template
## 4. Features to Enable
Go to: Settings → General → Features
**Enable:**
- ✅ Wikis (for extended documentation)
- ✅ Issues (already enabled)
- ✅ Discussions (for community Q&A)
- ✅ Projects (for roadmap tracking)
## 5. Issue Labels
Go to: Issues → Labels
**Add these labels:**
- `good first issue` (color: #7057ff) - For newcomers
- `help wanted` (color: #008672) - Community contributions welcome
- `documentation` (color: #0075ca) - Documentation improvements
- `enhancement` (color: #a2eeef) - New features
- `bug` (color: #d73a4a) - Something isn't working
- `question` (color: #d876e3) - Further information requested
## 6. GitHub Discussions
Go to: Settings → General → Features → Discussions
**Enable Discussions** and create these categories:
- 💡 Ideas - Feature requests and suggestions
- 🙏 Q&A - Questions and answers
- 📣 Announcements - Updates and releases
- 💬 General - General discussion
- 🎨 Show and Tell - Share your workflows
## 7. Branch Protection (Optional but Recommended)
Go to: Settings → Branches → Add rule
**For `main` branch:**
- ✅ Require pull request reviews before merging
- ✅ Require status checks to pass before merging
- ✅ Require conversation resolution before merging
## Verification Checklist
After completing the above:
- [ ] About section updated with keyword-rich description
- [ ] All 16 topics added
- [ ] Social preview image uploaded
- [ ] Discussions enabled
- [ ] Issue labels created
- [ ] At least 2-3 issues created with "good first issue" label
- [ ] First discussion post created welcoming contributors
## Quick Win Metrics
After these changes, you should see within 1 week:
- 📈 Improved GitHub search ranking for "AI agents", "code generation"
- 👀 Increased profile views from topic pages
- ⭐ More stars from improved discoverability
- 💬 Community engagement in Discussions
---
**Estimated Time:** 30-45 minutes total
**Expected Impact:** 10x improvement in discoverability