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
This commit is contained in:
darrenhinde
parent
e382efaa22
commit
7d75353d5a
6 changed files with 324 additions and 1 deletions
117
.github/GITHUB_SETTINGS.md
vendored
Normal file
117
.github/GITHUB_SETTINGS.md
vendored
Normal file
|
|
@ -0,0 +1,117 @@
|
|||
# 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`
|
||||
|
||||
## 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
|
||||
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
name: Bug Report
|
||||
about: Report a bug or issue with OpenCode Agents
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Description
|
||||
A clear and concise description of the bug.
|
||||
|
||||
## Steps to Reproduce
|
||||
1. Install profile: [core/developer/full/advanced]
|
||||
2. Run command: `...`
|
||||
3. See error: `...`
|
||||
|
||||
## Expected Behavior
|
||||
What you expected to happen.
|
||||
|
||||
## Actual Behavior
|
||||
What actually happened.
|
||||
|
||||
## Environment
|
||||
- OS: [e.g., macOS 14.0, Ubuntu 22.04]
|
||||
- OpenCode CLI version: [run `opencode --version`]
|
||||
- Installation profile: [core/developer/full/advanced]
|
||||
- Bash version: [run `bash --version`]
|
||||
|
||||
## Additional Context
|
||||
Add any other context, screenshots, or logs.
|
||||
|
||||
## Possible Solution (Optional)
|
||||
If you have ideas on how to fix this.
|
||||
27
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
27
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new feature or enhancement
|
||||
title: '[FEATURE] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Feature Description
|
||||
A clear and concise description of the feature you'd like to see.
|
||||
|
||||
## Problem It Solves
|
||||
What problem does this feature solve? What use case does it enable?
|
||||
|
||||
## Proposed Solution
|
||||
How would you like this feature to work?
|
||||
|
||||
## Alternatives Considered
|
||||
Have you considered any alternative solutions or features?
|
||||
|
||||
## Additional Context
|
||||
Add any other context, mockups, or examples.
|
||||
|
||||
## Would You Like to Contribute?
|
||||
- [ ] I'd like to work on this feature
|
||||
- [ ] I need help implementing this
|
||||
- [ ] I'm just suggesting the idea
|
||||
38
.github/ISSUE_TEMPLATE/good_first_issue.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/good_first_issue.md
vendored
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
name: Good First Issue
|
||||
about: Template for maintainers to create beginner-friendly issues
|
||||
title: '[GOOD FIRST ISSUE] '
|
||||
labels: 'good first issue, help wanted'
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Description
|
||||
A clear description of what needs to be done.
|
||||
|
||||
## Why This Matters
|
||||
Explain the impact of this change.
|
||||
|
||||
## Suggested Approach
|
||||
1. Step-by-step guidance
|
||||
2. Files to modify
|
||||
3. Expected outcome
|
||||
|
||||
## Resources
|
||||
- Link to relevant documentation
|
||||
- Similar examples in the codebase
|
||||
- External references if needed
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Criterion 1
|
||||
- [ ] Criterion 2
|
||||
- [ ] Tests added/updated
|
||||
- [ ] Documentation updated
|
||||
|
||||
## Getting Started
|
||||
1. Fork the repository
|
||||
2. Create a branch: `git checkout -b fix/issue-name`
|
||||
3. Make your changes
|
||||
4. Submit a PR referencing this issue
|
||||
|
||||
## Questions?
|
||||
Feel free to ask questions in the comments. We're here to help! 🙌
|
||||
79
CODE_OF_CONDUCT.md
Normal file
79
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
[INSERT CONTACT METHOD].
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
31
README.md
31
README.md
|
|
@ -1,6 +1,11 @@
|
|||
# OpenCode Agents
|
||||
|
||||
A set of OpenCode configurations, prompts, agents, and plugins for enhanced development workflows.
|
||||
[](https://github.com/darrenhinde/opencode-agents/stargazers)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://github.com/darrenhinde/opencode-agents/commits/main)
|
||||
[](CONTRIBUTING.md)
|
||||
|
||||
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.
|
||||
|
||||
[](https://youtu.be/EOIzFMdmox8?si=4ZSsVlAkhMxVmF2R)
|
||||
|
||||
|
|
@ -226,6 +231,30 @@ cp env.example .env
|
|||
|
||||
---
|
||||
|
||||
## How It Compares
|
||||
|
||||
### vs GitHub Copilot
|
||||
- ✅ **Plan-first workflow** - Proposes plans before executing (Copilot executes immediately)
|
||||
- ✅ **Approval-based** - You review and approve each step (Copilot auto-completes)
|
||||
- ✅ **Multi-agent system** - Specialized agents for testing, review, docs (Copilot is single-purpose)
|
||||
- ✅ **Context-aware** - Follows your coding patterns from context files
|
||||
|
||||
### vs Cursor
|
||||
- ✅ **IDE-agnostic** - Works with any editor (Cursor is IDE-specific)
|
||||
- ✅ **Multi-agent coordination** - Task delegation between specialized agents
|
||||
- ✅ **Workflow orchestration** - Manages complex multi-step features
|
||||
- ✅ **Open source** - Fully customizable and extensible
|
||||
|
||||
### vs Aider
|
||||
- ✅ **Visual workflow** - Interactive menus and progress tracking (Aider is CLI-only)
|
||||
- ✅ **Subagent system** - Automatic delegation to specialized agents
|
||||
- ✅ **Built-in validation** - Type checking, testing, and review integrated
|
||||
- ✅ **Installation profiles** - Choose your feature set (core, developer, full)
|
||||
|
||||
**Key Differentiator:** OpenCode Agents is the only framework that combines plan-first workflows, approval-based execution, and multi-agent coordination with your custom coding patterns.
|
||||
|
||||
---
|
||||
|
||||
## Common Questions
|
||||
|
||||
**Q: What's the main way to use this?**
|
||||
|
|
|
|||
Loading…
Reference in a new issue