diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0bd2267 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,31 @@ +## Submission Type + + +- [ ] Plugin +- [ ] Project +- [ ] Theme +- [ ] Agent +- [ ] Resource + +## Details + +**Name:** +**Repository:** +**Description:** + +## 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 + + + +```html + +``` diff --git a/.github/PULL_REQUEST_TEMPLATE/agent.md b/.github/PULL_REQUEST_TEMPLATE/agent.md new file mode 100644 index 0000000..620bac8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/agent.md @@ -0,0 +1,34 @@ +--- +name: Add Agent +about: Submit a new agent to the awesome-opencode list +--- + +## Agent Submission + +**Name:** +**Repository:** +**Description:** + +## 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 +
+ Agent Name - Short description +
+ Full description here. +

+ 🔗 View Repository +
+
+``` diff --git a/.github/PULL_REQUEST_TEMPLATE/plugin.md b/.github/PULL_REQUEST_TEMPLATE/plugin.md new file mode 100644 index 0000000..8cc8000 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/plugin.md @@ -0,0 +1,34 @@ +--- +name: Add Plugin +about: Submit a new plugin to the awesome-opencode list +--- + +## Plugin Submission + +**Name:** +**Repository:** +**Description:** + +## 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 +
+ Plugin Name - Short description +
+ Full description here. +

+ 🔗 View Repository +
+
+``` diff --git a/.github/PULL_REQUEST_TEMPLATE/project.md b/.github/PULL_REQUEST_TEMPLATE/project.md new file mode 100644 index 0000000..37f2481 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/project.md @@ -0,0 +1,34 @@ +--- +name: Add Project +about: Submit a new project to the awesome-opencode list +--- + +## Project Submission + +**Name:** +**Repository:** +**Description:** + +## 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 +
+ Project Name - Short description +
+ Full description here. +

+ 🔗 View Repository +
+
+``` diff --git a/.github/PULL_REQUEST_TEMPLATE/resource.md b/.github/PULL_REQUEST_TEMPLATE/resource.md new file mode 100644 index 0000000..5a2948e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/resource.md @@ -0,0 +1,35 @@ +--- +name: Add Resource +about: Submit a new resource to the awesome-opencode list +--- + +## Resource Submission + +**Name:** +**URL:** +**Description:** + +## 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 +
+ Resource Name - Short description +
+ Full description here. +

+ 🔗 View Repository +
+
+``` + +Note: For non-GitHub resources (guides, articles, etc.), omit the star badge. diff --git a/.github/PULL_REQUEST_TEMPLATE/theme.md b/.github/PULL_REQUEST_TEMPLATE/theme.md new file mode 100644 index 0000000..b3a07e9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/theme.md @@ -0,0 +1,33 @@ +--- +name: Add Theme +about: Submit a new theme to the awesome-opencode list +--- + +## Theme Submission + +**Name:** +**Repository:** +**Description:** + +## 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 +
+ Theme Name - Short description +
+ Full description here. +

+ 🔗 View Repository +
+
+``` diff --git a/README.md b/README.md index 42217c6..d84e611 100644 --- a/README.md +++ b/README.md @@ -233,7 +233,7 @@
-➕ Suggest a Plugin +➕ Add a Plugin via PR
@@ -254,7 +254,7 @@
-➕ Suggest a Theme +➕ Add a Theme via PR
@@ -293,7 +293,7 @@
-➕ Suggest an Agent +➕ Add an Agent via PR
@@ -467,7 +467,7 @@
-➕ Suggest a Project +➕ Add a Project via PR
@@ -497,7 +497,7 @@
-➕ Suggest a Resource +➕ Add a Resource via PR

@@ -505,7 +505,7 @@

🤝 Contributing

Found an Awesome Opencode project?
-Start a discussion in the appropriate category! +Submit a Pull Request to add it to the list!

Released under CC0 1.0 Universal.
diff --git a/contributing.md b/contributing.md index dcd9e08..ddf3b8d 100644 --- a/contributing.md +++ b/contributing.md @@ -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 +
+ Your Project Name - Short description +
+ Full description here. +

+ 🔗 View Repository +
+
+``` + +**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 +
+ opencode-example - Brief description of what it does +
+ Longer description with more details about the plugin. +

+ 🔗 View Repository +
+
+``` + +### Project +```html +
+ My Project - Brief description +
+ Longer description with more details. +

+ 🔗 View Repository +
+
+``` + +### Theme +```html +
+ My Theme - Color scheme description +
+ Theme description and color details. +

+ 🔗 View Repository +
+
+``` ## 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!