OpenWriterControle/docs/github/GITHUB_SETTINGS.md
darrenhinde ca323285b2 Rename to OpenAgents, remove model specs, and update documentation
Major Changes:
- Rename repository from opencode-agents to OpenAgents
- Remove all hardcoded model specifications (now model-agnostic)
- Fix documentation: profile names, component counts, add Business profile
- Add future plans note for other AI coding tools

Repository Rename:
- Update all URLs to github.com/darrenhinde/OpenAgents
- Update git remote, README, install scripts, documentation
- 15 files updated with new repository name

Model-Agnostic Framework:
- Remove model specifications from 6 agent files
- Framework now works with any AI provider (Claude, GPT, Gemini, local models)
- Users control model selection via OpenCode CLI settings

Documentation Fixes:
- Correct profile name: Core → Essential
- Add missing Business profile documentation
- Fix component counts: Developer (19), Advanced (32)
- Document all 5 profiles with accurate descriptions

Future Plans:
- Add note about support for other AI tools (Cursor, Claude Code, etc.)
- Clear focus on stabilizing OpenCode integration first

This makes OpenAgents a truly universal, model-agnostic framework
accessible to all users regardless of their AI provider preference.
2025-11-18 22:37:41 +00:00

117 lines
3 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/OpenAgents`
## 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