mirror of
https://github.com/Heretek-AI/awesome-opencode.git
synced 2026-11-07 10:45:57 -10:00
feat: switch from discussions to PR-based contributions
- Add PR templates for plugins, projects, themes, agents, resources - Update contributing.md with PR-based workflow and entry templates - Replace all 'Suggest via Discussion' links with 'Add via PR' links - Add quick copy templates for each entry type - Keep existing discussion links for resource entries (they link to content)
This commit is contained in:
shamanic committed
1 parent
79125d5c48
commit
9baf586660
8 files changed
+303
-28
No files matched your search
@@ -0,0 +1,31 @@
|
||||
## Submission Type
|
||||
|
||||
<!-- Check one -->
|
||||
- [ ] Plugin
|
||||
- [ ] Project
|
||||
- [ ] Theme
|
||||
- [ ] Agent
|
||||
- [ ] Resource
|
||||
|
||||
## Details
|
||||
|
||||
**Name:**
|
||||
**Repository:**
|
||||
**Description:** <!-- One sentence -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Relevant to OpenCode
|
||||
- [ ] Repository is public and accessible
|
||||
- [ ] Actively maintained
|
||||
- [ ] Not a duplicate
|
||||
- [ ] Entry added in alphabetical order
|
||||
- [ ] Used correct collapsible format
|
||||
|
||||
## Entry Added
|
||||
|
||||
<!-- Paste the entry you added to README.md -->
|
||||
|
||||
```html
|
||||
|
||||
```
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: Add Agent
|
||||
about: Submit a new agent to the awesome-opencode list
|
||||
---
|
||||
|
||||
## Agent Submission
|
||||
|
||||
**Name:** <!-- e.g., my-opencode-agent -->
|
||||
**Repository:** <!-- e.g., https://github.com/username/my-opencode-agent -->
|
||||
**Description:** <!-- One sentence, max 100 chars -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Agent is relevant to OpenCode
|
||||
- [ ] Repository is public and accessible
|
||||
- [ ] Agent is actively maintained (commits within last 6 months)
|
||||
- [ ] Not a duplicate (checked existing list)
|
||||
- [ ] Entry added to README.md in alphabetical order
|
||||
- [ ] Used the correct format (see below)
|
||||
|
||||
## Entry Format
|
||||
|
||||
Add this to the **Agents** section in alphabetical order:
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary><b>Agent Name</b> <img src="https://badgen.net/github/stars/owner/repo" height="14"/> - <i>Short description</i></summary>
|
||||
<blockquote>
|
||||
Full description here.
|
||||
<br><br>
|
||||
<a href="https://github.com/owner/repo">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: Add Plugin
|
||||
about: Submit a new plugin to the awesome-opencode list
|
||||
---
|
||||
|
||||
## Plugin Submission
|
||||
|
||||
**Name:** <!-- e.g., opencode-my-plugin -->
|
||||
**Repository:** <!-- e.g., https://github.com/username/opencode-my-plugin -->
|
||||
**Description:** <!-- One sentence, max 100 chars -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Plugin is relevant to OpenCode
|
||||
- [ ] Repository is public and accessible
|
||||
- [ ] Plugin is actively maintained (commits within last 6 months)
|
||||
- [ ] Not a duplicate (checked existing list)
|
||||
- [ ] Entry added to README.md in alphabetical order
|
||||
- [ ] Used the correct format (see below)
|
||||
|
||||
## Entry Format
|
||||
|
||||
Add this to the **Plugins** section in alphabetical order:
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary><b>Plugin Name</b> <img src="https://badgen.net/github/stars/owner/repo" height="14"/> - <i>Short description</i></summary>
|
||||
<blockquote>
|
||||
Full description here.
|
||||
<br><br>
|
||||
<a href="https://github.com/owner/repo">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
name: Add Project
|
||||
about: Submit a new project to the awesome-opencode list
|
||||
---
|
||||
|
||||
## Project Submission
|
||||
|
||||
**Name:** <!-- e.g., my-opencode-project -->
|
||||
**Repository:** <!-- e.g., https://github.com/username/my-opencode-project -->
|
||||
**Description:** <!-- One sentence, max 100 chars -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Project is relevant to OpenCode
|
||||
- [ ] Repository is public and accessible
|
||||
- [ ] Project is actively maintained (commits within last 6 months)
|
||||
- [ ] Not a duplicate (checked existing list)
|
||||
- [ ] Entry added to README.md in alphabetical order
|
||||
- [ ] Used the correct format (see below)
|
||||
|
||||
## Entry Format
|
||||
|
||||
Add this to the **Projects** section in alphabetical order:
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary><b>Project Name</b> <img src="https://badgen.net/github/stars/owner/repo" height="14"/> - <i>Short description</i></summary>
|
||||
<blockquote>
|
||||
Full description here.
|
||||
<br><br>
|
||||
<a href="https://github.com/owner/repo">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
name: Add Resource
|
||||
about: Submit a new resource to the awesome-opencode list
|
||||
---
|
||||
|
||||
## Resource Submission
|
||||
|
||||
**Name:** <!-- e.g., My OpenCode Guide -->
|
||||
**URL:** <!-- e.g., https://github.com/username/opencode-config -->
|
||||
**Description:** <!-- One sentence, max 100 chars -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Resource is relevant to OpenCode
|
||||
- [ ] URL is public and accessible
|
||||
- [ ] Not a duplicate (checked existing list)
|
||||
- [ ] Entry added to README.md in alphabetical order
|
||||
- [ ] Used the correct format (see below)
|
||||
|
||||
## Entry Format
|
||||
|
||||
Add this to the **Resources** section in alphabetical order:
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary><b>Resource Name</b> <img src="https://badgen.net/github/stars/owner/repo" height="14"/> - <i>Short description</i></summary>
|
||||
<blockquote>
|
||||
Full description here.
|
||||
<br><br>
|
||||
<a href="https://github.com/owner/repo">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
|
||||
Note: For non-GitHub resources (guides, articles, etc.), omit the star badge.
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
name: Add Theme
|
||||
about: Submit a new theme to the awesome-opencode list
|
||||
---
|
||||
|
||||
## Theme Submission
|
||||
|
||||
**Name:** <!-- e.g., My Awesome Theme -->
|
||||
**Repository:** <!-- e.g., https://github.com/username/opencode-theme -->
|
||||
**Description:** <!-- One sentence, max 100 chars -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Theme is for OpenCode
|
||||
- [ ] Repository is public and accessible
|
||||
- [ ] Not a duplicate (checked existing list)
|
||||
- [ ] Entry added to README.md in alphabetical order
|
||||
- [ ] Used the correct format (see below)
|
||||
|
||||
## Entry Format
|
||||
|
||||
Add this to the **Themes** section in alphabetical order:
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary><b>Theme Name</b> <img src="https://badgen.net/github/stars/owner/repo" height="14"/> - <i>Short description</i></summary>
|
||||
<blockquote>
|
||||
Full description here.
|
||||
<br><br>
|
||||
<a href="https://github.com/owner/repo">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
@@ -233,7 +233,7 @@
|
||||
</details>
|
||||
|
||||
<br>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/discussions/categories/plugins"><b>➕ Suggest a Plugin</b></a>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/blob/main/contributing.md"><b>➕ Add a Plugin via PR</b></a>
|
||||
</details>
|
||||
|
||||
<br>
|
||||
@@ -254,7 +254,7 @@
|
||||
</details>
|
||||
|
||||
<br>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/discussions/categories/themes"><b>➕ Suggest a Theme</b></a>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/blob/main/contributing.md"><b>➕ Add a Theme via PR</b></a>
|
||||
</details>
|
||||
|
||||
<br>
|
||||
@@ -293,7 +293,7 @@
|
||||
</details>
|
||||
|
||||
<br>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/discussions/categories/agents"><b>➕ Suggest an Agent</b></a>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/blob/main/contributing.md"><b>➕ Add an Agent via PR</b></a>
|
||||
</details>
|
||||
|
||||
<br>
|
||||
@@ -467,7 +467,7 @@
|
||||
</details>
|
||||
|
||||
<br>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/discussions/categories/projects"><b>➕ Suggest a Project</b></a>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/blob/main/contributing.md"><b>➕ Add a Project via PR</b></a>
|
||||
</details>
|
||||
|
||||
<br>
|
||||
@@ -497,7 +497,7 @@
|
||||
</details>
|
||||
|
||||
<br>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/discussions/categories/resources"><b>➕ Suggest a Resource</b></a>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/blob/main/contributing.md"><b>➕ Add a Resource via PR</b></a>
|
||||
</details>
|
||||
|
||||
<br><br>
|
||||
@@ -505,7 +505,7 @@
|
||||
<div align="center">
|
||||
<h3>🤝 Contributing</h3>
|
||||
Found an Awesome Opencode project? <br>
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/discussions"><b>Start a discussion</b></a> in the appropriate category!
|
||||
<a href="https://github.com/awesome-opencode/awesome-opencode/blob/main/contributing.md"><b>Submit a Pull Request</b></a> to add it to the list!
|
||||
<br><br>
|
||||
<sub>Released under <a href="https://creativecommons.org/publicdomain/zero/1.0/">CC0 1.0 Universal</a>.</sub>
|
||||
</div>
|
||||
+96
-22
@@ -1,33 +1,107 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
Thank you for your interest in contributing to `awesome-opencode`! Your suggestions are essential for making this list a great resource for the community. We're excited to see what you've found.
|
||||
Thank you for your interest in contributing to `awesome-opencode`! Your contributions help make this list a great resource for the community.
|
||||
|
||||
To keep things organized and allow for community input, **we manage all new additions through GitHub Discussions.**
|
||||
## How to Add an Entry
|
||||
|
||||
## How to Suggest an Addition
|
||||
**Submit a Pull Request** adding your entry directly to the README.
|
||||
|
||||
Instead of opening a Pull Request, please follow these simple steps:
|
||||
### Step 1: Fork & Clone
|
||||
|
||||
1. **Go to the [Discussions Tab](https://github.com/awesome-opencode/awesome-opencode/discussions)**.
|
||||
2. **Choose the correct category** for your suggestion (e.g., `Plugins`, `Themes`, `Agents`, etc.).
|
||||
3. **Start a new Discussion** with a clear title.
|
||||
4. In the body, please include:
|
||||
* A link to the resource.
|
||||
* A brief, one-sentence description of what it is and why it's awesome.
|
||||
```bash
|
||||
git clone https://github.com/YOUR-USERNAME/awesome-opencode.git
|
||||
cd awesome-opencode
|
||||
```
|
||||
|
||||
Here's the format to follow:
|
||||
`[Project Name](link) - A short description.`
|
||||
### Step 2: Add Your Entry
|
||||
|
||||
Add your entry to the appropriate section in `README.md` in **alphabetical order**.
|
||||
|
||||
Use this format:
|
||||
|
||||
```html
|
||||
<details>
|
||||
<summary><b>Your Project Name</b> <img src="https://badgen.net/github/stars/owner/repo" height="14"/> - <i>Short description</i></summary>
|
||||
<blockquote>
|
||||
Full description here.
|
||||
<br><br>
|
||||
<a href="https://github.com/owner/repo">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
|
||||
**Sections:**
|
||||
- **Plugins** - OpenCode plugins and extensions
|
||||
- **Themes** - Color schemes and visual themes
|
||||
- **Agents** - AI agents and subagents
|
||||
- **Projects** - Tools, GUIs, integrations, and utilities
|
||||
- **Resources** - Guides, templates, and configurations
|
||||
|
||||
### Step 3: Submit PR
|
||||
|
||||
```bash
|
||||
git checkout -b add-my-project
|
||||
git add README.md
|
||||
git commit -m "docs: add my-project to plugins"
|
||||
git push origin add-my-project
|
||||
```
|
||||
|
||||
Then open a Pull Request on GitHub.
|
||||
|
||||
## Entry Requirements
|
||||
|
||||
Before submitting, ensure your entry:
|
||||
|
||||
- [ ] **Is relevant** - Directly related to OpenCode
|
||||
- [ ] **Is public** - Repository is publicly accessible
|
||||
- [ ] **Is maintained** - Active commits within the last 6 months
|
||||
- [ ] **Is not a duplicate** - Check the list first
|
||||
- [ ] **Is alphabetically ordered** - Placed correctly in the section
|
||||
- [ ] **Uses correct format** - Collapsible details with star badge
|
||||
|
||||
## Quick Copy Templates
|
||||
|
||||
### Plugin
|
||||
```html
|
||||
<details>
|
||||
<summary><b>opencode-example</b> <img src="https://badgen.net/github/stars/username/opencode-example" height="14"/> - <i>Brief description of what it does</i></summary>
|
||||
<blockquote>
|
||||
Longer description with more details about the plugin.
|
||||
<br><br>
|
||||
<a href="https://github.com/username/opencode-example">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
|
||||
### Project
|
||||
```html
|
||||
<details>
|
||||
<summary><b>My Project</b> <img src="https://badgen.net/github/stars/username/my-project" height="14"/> - <i>Brief description</i></summary>
|
||||
<blockquote>
|
||||
Longer description with more details.
|
||||
<br><br>
|
||||
<a href="https://github.com/username/my-project">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
|
||||
### Theme
|
||||
```html
|
||||
<details>
|
||||
<summary><b>My Theme</b> <img src="https://badgen.net/github/stars/username/opencode-my-theme" height="14"/> - <i>Color scheme description</i></summary>
|
||||
<blockquote>
|
||||
Theme description and color details.
|
||||
<br><br>
|
||||
<a href="https://github.com/username/opencode-my-theme">🔗 <b>View Repository</b></a>
|
||||
</blockquote>
|
||||
</details>
|
||||
```
|
||||
|
||||
## What Happens Next?
|
||||
|
||||
Once you've submitted your suggestion, a maintainer will review it. This allows us to ensure everything on the list is high-quality, relevant, and well-documented. If your suggestion is approved, a maintainer will add it to the list.
|
||||
A maintainer will review your PR and:
|
||||
- Verify the project meets our guidelines
|
||||
- Check for security concerns
|
||||
- Merge if approved, or request changes
|
||||
|
||||
## Guideline for a Great Suggestion
|
||||
|
||||
To ensure your suggestion gets added quickly, please make sure it meets the following criteria:
|
||||
|
||||
- **It's relevant:** The resource is directly related to opencode.
|
||||
- **It's awesome:** It's a useful, high-quality, and well-maintained project.
|
||||
- **It's not a duplicate:** Please check the list to make sure your suggestion isn't already there.
|
||||
|
||||
That's it! We look forward to seeing your suggestions. Thank you for helping build this community resource
|
||||
Thank you for contributing to the OpenCode community!
|
||||
Reference in new issue
Block a user