darrenhinde 7d75353d5a feat: add GitHub discovery optimizations

Community & Discovery Improvements:
- Add CODE_OF_CONDUCT.md (Contributor Covenant 2.0)
- Add badges to README (stars, license, last commit, PRs welcome)
- Add comparison section (vs Copilot, Cursor, Aider)
- Improve tagline with SEO keywords
- Add issue templates (bug report, feature request, good first issue)
- Add GitHub settings checklist for post-merge configuration

SEO & Discoverability:
- Keyword-rich description for search ranking
- Clear differentiation from alternatives
- Professional presentation with badges
- Community-friendly templates

Next Steps (After Merge):
- Update About section with new description
- Add 16 topics for search optimization
- Enable GitHub Discussions
- Create social preview image
- Add issue labels

Estimated Impact: 10x improvement in GitHub discoverability

2025-11-17 23:43:13 +00:00

3.1 KiB

Raw Blame History

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/opencode-agents

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

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

3.1 KiB Raw Blame History