Enhance README with comparison table, badges, and add CONTRIBUTING.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Quanlai Li
2026-02-18 09:07:31 -08:00
parent a7d08a60a6
commit 69c1458264
2 changed files with 211 additions and 15 deletions
+105
View File
@@ -0,0 +1,105 @@
# Contributing to OpenClaudia
Thanks for your interest in contributing! OpenClaudia is an open-source marketing toolkit for AI coding agents, and we welcome contributions of all kinds.
## Ways to Contribute
- **New skills** — add a marketing skill that solves a real problem
- **Bug fixes** — fix issues in existing skills
- **Documentation** — improve README, skill descriptions, or examples
- **API integrations** — connect skills to new marketing APIs
- **Translations** — help make skills work in more languages
## Creating a New Skill
### 1. Pick a skill idea
Check [open issues](https://github.com/OpenClaudia/openclaudia-skills/issues) for requested skills, or propose your own. If you're unsure whether your idea fits, open an issue to discuss first.
### 2. Create the skill directory
```
skills/
your-skill-name/
SKILL.md # Required — the skill definition
```
Skill names should be lowercase, hyphenated, and descriptive: `seo-audit`, `write-blog`, `email-sequence`.
### 3. Write the SKILL.md
Every skill is a single `SKILL.md` file with YAML frontmatter and detailed instructions:
```markdown
---
name: your-skill-name
description: One-line description of what this skill does (shown in skill list)
---
# Your Skill Name
Detailed instructions that the AI agent will follow when this skill is invoked.
## When to use this skill
Describe the trigger phrases and use cases.
## What this skill does
Step-by-step instructions for the agent:
1. Gather input from the user
2. Call APIs or read files
3. Generate output
4. Write results to disk or take action
## API Requirements (if any)
List any API keys needed and how to configure them.
```
### 4. Skill authoring guidelines
- **Be specific** — the more precise your instructions, the better the agent performs
- **Include examples** — show the agent what good output looks like
- **Handle errors** — tell the agent what to do when an API key is missing or a request fails
- **Keep it focused** — one skill should do one thing well
- **Test it** — run your skill in Claude Code before submitting
### 5. Submit a pull request
1. Fork the repo
2. Create a branch: `git checkout -b skill/your-skill-name`
3. Add your skill directory under `skills/`
4. Update the README if your skill adds a new category
5. Open a PR with:
- What the skill does
- How you tested it
- Any API keys required
## Code Review Standards
We review PRs for:
- **Correctness** — does the skill do what it claims?
- **Clarity** — are the instructions clear and unambiguous?
- **Safety** — does the skill avoid destructive actions without user confirmation?
- **Privacy** — does the skill avoid sending user data to unexpected third parties?
## Reporting Issues
Found a bug or have a feature request? [Open an issue](https://github.com/OpenClaudia/openclaudia-skills/issues/new) with:
- Skill name (if applicable)
- What you expected to happen
- What actually happened
- Your environment (OS, Claude Code version)
## Community
- **GitHub Issues** — bug reports and feature requests
- **GitHub Discussions** — questions and ideas
- **Twitter/X** — [@Claudia1569302](https://x.com/Claudia1569302)
## License
By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).
+106 -15
View File
@@ -1,20 +1,86 @@
# OpenClaudia Skills
<p align="center">
<img src="https://openclaudia.com/avatar.png" width="120" alt="OpenClaudia" />
</p>
Open-source marketing skills for [Claude Code](https://docs.anthropic.com/en/docs/claude-code). The tool for marketers, like Claude Code is for programmers.
<h1 align="center">OpenClaudia</h1>
**Website:** [openclaudia.com](https://openclaudia.com)
<p align="center">
<strong>The open-source marketing toolkit for AI coding agents.</strong><br/>
55+ modular skills that turn Claude Code into a full marketing department.
</p>
## Quick Install
<p align="center">
<a href="https://www.npmjs.com/package/openclaudia"><img src="https://img.shields.io/npm/v/openclaudia?color=blue&label=npm" alt="npm version" /></a>
<a href="https://github.com/OpenClaudia/openclaudia-skills/stargazers"><img src="https://img.shields.io/github/stars/OpenClaudia/openclaudia-skills?style=social" alt="GitHub Stars" /></a>
<a href="https://github.com/OpenClaudia/openclaudia-skills/blob/main/LICENSE"><img src="https://img.shields.io/github/license/OpenClaudia/openclaudia-skills" alt="License: MIT" /></a>
<a href="https://openclaudia.com"><img src="https://img.shields.io/badge/website-openclaudia.com-purple" alt="Website" /></a>
</p>
<p align="center">
<a href="https://openclaudia.com">Website</a> · <a href="#quick-start">Quick Start</a> · <a href="#skills">Skills</a> · <a href="https://github.com/OpenClaudia/openclaudia-skills/issues">Issues</a> · <a href="CONTRIBUTING.md">Contributing</a>
</p>
---
## Why OpenClaudia?
Most AI marketing tools charge **$50300/month** for a chat box that gives you suggestions. OpenClaudia is different:
| | SaaS Marketing Tools | OpenClaudia |
|---|---|---|
| **Price** | $50300/month | Free & open source |
| **Execution** | Suggests copy, you do the rest | Actually writes, publishes, sends |
| **Data privacy** | Your data on their servers | Runs locally on your machine |
| **Customization** | Limited to their UI | Fork, modify, extend any skill |
| **Integration** | Walled garden | Works with 20+ APIs you already use |
| **Setup** | Sign up, onboard, learn their UI | One command: `npx openclaudia install --all` |
## Quick Start
**Prerequisites:** [Claude Code](https://docs.anthropic.com/en/docs/claude-code) installed and authenticated.
```bash
# Install all skills
npx skills add OpenClaudia/openclaudia-skills
# Install all 55+ marketing skills
npx openclaudia install --all
# Install a specific skill
npx skills add OpenClaudia/openclaudia-skills --skill seo-audit
# Or install specific skills
npx openclaudia install seo-audit write-blog email-sequence
```
Or manually copy any skill directory into `~/.claude/skills/` (personal) or `.claude/skills/` (project).
Then open Claude Code and start marketing:
```
$ claude
> /audit-seo https://mysite.com
✓ Analyzing 47 pages... SEO score: 72/100 — 12 issues found
> /write-blog "10 Tips for SaaS Growth"
✓ 2,400-word article generated with meta tags
> /email-sequence --type product-launch
✓ 6-email drip sequence created and sent via Resend
> /competitor-analysis competitor.com
✓ Full SEO, content, and positioning breakdown
> /discord-bot "New feature just dropped!"
✓ Rich embed posted to #announcements
```
### Alternative installation
```bash
# Via the skills CLI
npx skills add OpenClaudia/openclaudia-skills
# Install a single skill
npx skills add OpenClaudia/openclaudia-skills --skill seo-audit
# Manual: copy any skill directory into your skills folder
cp -r skills/seo-audit ~/.claude/skills/ # personal
cp -r skills/seo-audit .claude/skills/ # project-level
```
## Skills
@@ -119,7 +185,7 @@ Or manually copy any skill directory into `~/.claude/skills/` (personal) or `.cl
Some skills integrate with external APIs for live data. Set these in your `.env` or `~/.claude/.env.global`:
```bash
# Email sending (email-sequence, email-subject-lines)
# Email (email-sequence, email-subject-lines)
RESEND_API_KEY=your_key_here
# SemRush (keyword-research, semrush-research, backlink-audit, competitor-analysis)
@@ -184,25 +250,50 @@ FEISHU_APP_ID=your_app_id
FEISHU_APP_SECRET=your_app_secret
```
All API keys are optional. Skills work without them but provide richer data when keys are available. Each skill tells you which key is needed when invoked.
All API keys are optional — skills work without them but provide richer data when configured. Each skill tells you which key is needed when invoked.
## Works With Any AI Coding Agent
OpenClaudia skills are designed for **Claude Code** but also work with:
- **OpenAI Codex** — drop skills into your agent's tools directory
- **Cursor / Windsurf** — use as custom instructions or rules
- **Any agent** that supports markdown instruction files
## Contributing
We welcome contributions! Whether it's a new marketing skill, a bug fix, or documentation improvement.
1. Fork this repository
2. Create a new skill directory under `skills/`
3. Add a `SKILL.md` with YAML frontmatter and instructions
4. Submit a pull request
See [CONTRIBUTING.md](CONTRIBUTING.md) for the full guide.
See **[CONTRIBUTING.md](CONTRIBUTING.md)** for the full guide, including skill authoring conventions and code review standards.
### Good first issues
Look for issues tagged [`help wanted`](https://github.com/OpenClaudia/openclaudia-skills/labels/help%20wanted) — these are curated for new contributors.
## Ecosystem
OpenClaudia is part of a growing ecosystem of AI agent tools:
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) — the AI coding agent by Anthropic
- [GEO Guide](https://howtowingeo.com) — how to win at Generative Engine Optimization
- [PageGun](https://pagegun.com) — AI-powered CMS for content publishing
## License
MIT - see [LICENSE](LICENSE)
MIT see [LICENSE](LICENSE)
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=OpenClaudia/openclaudia-skills&type=Date)](https://star-history.com/#OpenClaudia/openclaudia-skills&Date)
## Created by
---
[Quanlai Li](https://quanl.ai) and the OpenClaudia community.
<p align="center">
Created by <a href="https://quanl.ai">Quanlai Li</a> and the OpenClaudia community.<br/>
<sub>Not affiliated with Anthropic.</sub>
</p>