ayrisdev/marketingskills
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add repo essentials and GitHub templates

Browse Source 
- Add MIT LICENSE file
- Add CONTRIBUTING.md with skill creation guide
- Add AGENTS.md and CLAUDE.md for AI agent guidelines
- Add issue template for skill requests
- Add PR templates for new skills, updates, and docs
- Update README with links to contributing guide and license
This commit is contained in:
Ben Sabic
2026-01-26 09:37:57 +11:00
parent 21f0ce7f6e
commit 6406f9e89b
10 changed files with 406 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Agent Skills Specification
url: https://agentskills.io/specification.md
about: Learn the skill format before creating or requesting a skill
- name: Contributing Guide
url: https://github.com/coreyhaines31/marketingskills/blob/main/CONTRIBUTING.md
about: How to contribute a new skill to this repository

74
.github/ISSUE_TEMPLATE/skill-request.yml vendored Normal file
View File

@@ -0,0 +1,74 @@
name: Skill Request
description: Request a new marketing skill
title: "Skill Request: [skill-name]"
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new skill! Please fill out the details below.
- type: input
id: skill-name
attributes:
label: Suggested skill name
description: Lowercase, hyphens only (e.g., "landing-page-audit")
placeholder: "my-skill-name"
validations:
required: true
- type: textarea
id: description
attributes:
label: What should this skill do?
description: Describe the skill's purpose and capabilities
placeholder: "This skill should help with..."
validations:
required: true
- type: textarea
id: triggers
attributes:
label: When should it be used?
description: What trigger phrases or scenarios should activate this skill?
placeholder: |
- When the user says "..."
- When working on...
validations:
required: true
- type: textarea
id: examples
attributes:
label: Example use cases
description: Provide 1-3 specific examples of how you'd use this skill
placeholder: |
1. I want to...
2. Help me...
validations:
required: false
- type: dropdown
id: category
attributes:
label: Category
description: Which category does this skill fit into?
options:
- CRO (Conversion Rate Optimization)
- Copywriting
- SEO
- Paid Ads
- Growth / Strategy
- Analytics
- Other
validations:
required: true
- type: textarea
id: related-skills
attributes:
label: Related existing skills
description: Are there existing skills this relates to or differs from?
placeholder: "Similar to page-cro but focused on..."
validations:
required: false

15
.github/PULL_REQUEST_TEMPLATE/documentation.md vendored Normal file
View File

@@ -0,0 +1,15 @@
## Documentation
## Summary
<!-- What documentation changes are you making? -->
## Files changed
<!-- List the files you're updating -->
## Checklist
- [ ] Links are valid
- [ ] Formatting is consistent with existing docs
- [ ] No sensitive data or credentials

16
.github/PULL_REQUEST_TEMPLATE/new-skill.md vendored Normal file
View File

@@ -0,0 +1,16 @@
## New Skill
**Skill name:** `skills/SKILL-NAME`
## Summary
<!-- What does this skill do and when should it be used? -->
## Checklist
- [ ] `name` matches directory name exactly
- [ ] `name` follows naming rules (lowercase, hyphens, no `--`)
- [ ] `description` is 1-1024 chars with trigger phrases
- [ ] `SKILL.md` is under 500 lines
- [ ] No sensitive data or credentials
- [ ] Tested locally with AI agent

21
.github/PULL_REQUEST_TEMPLATE/skill-update.md vendored Normal file
View File

@@ -0,0 +1,21 @@
## Skill Update
**Skill:** `skills/SKILL-NAME`
## Summary
<!-- What changes are you making and why? -->
## Type of update
- [ ] Bug fix
- [ ] Improved instructions
- [ ] Added references/scripts
- [ ] Other
## Checklist
- [ ] Changes are focused and minimal
- [ ] `SKILL.md` is still under 500 lines
- [ ] No sensitive data or credentials
- [ ] Tested locally with AI agent

157
AGENTS.md Normal file
View File

@@ -0,0 +1,157 @@
# AGENTS.md
Guidelines for AI agents working in this repository.
## Repository Overview
This repository contains **Agent Skills** for AI agents following the [Agent Skills specification](https://agentskills.io/specification.md). It also serves as a **Claude Code plugin marketplace** via `.claude-plugin/marketplace.json`.
- **Name**: Marketing Skills
- **GitHub**: [coreyhaines31/marketingskills](https://github.com/coreyhaines31/marketingskills)
- **Creator**: Corey Haines
- **License**: MIT
## Repository Structure
```
marketingskills/
├── .claude-plugin/
│ └── marketplace.json # Claude Code plugin marketplace manifest
├── skills/ # Agent Skills
│ └── skill-name/
│ └── SKILL.md # Required skill file
├── CONTRIBUTING.md
├── LICENSE
└── README.md
```
## Build / Lint / Test Commands
**Not applicable** - This is a content-only repository with no executable code.
Verify manually:
- YAML frontmatter is valid
- `name` field matches directory name exactly
- `name` is 1-64 chars, lowercase alphanumeric and hyphens only
- `description` is 1-1024 characters
## Agent Skills Specification
Skills follow the [Agent Skills spec](https://agentskills.io/specification.md).
### Required Frontmatter
```yaml
---
name: skill-name
description: What this skill does and when to use it. Include trigger phrases.
---
```
### Frontmatter Field Constraints
| Field | Required | Constraints |
|---------------|----------|------------------------------------------------------------------|
| `name` | Yes | 1-64 chars, lowercase `a-z`, numbers, hyphens. Must match dir. |
| `description` | Yes | 1-1024 chars. Describe what it does and when to use it. |
| `license` | No | License name (default: MIT) |
| `metadata` | No | Key-value pairs (author, version, etc.) |
### Name Field Rules
- Lowercase letters, numbers, and hyphens only
- Cannot start or end with hyphen
- No consecutive hyphens (`--`)
- Must match parent directory name exactly
**Valid**: `page-cro`, `email-sequence`, `ab-test-setup`
**Invalid**: `Page-CRO`, `-page`, `page--cro`
### Optional Skill Directories
```
skills/skill-name/
├── SKILL.md # Required - main instructions (<500 lines)
├── references/ # Optional - detailed docs loaded on demand
├── scripts/ # Optional - executable code
└── assets/ # Optional - templates, data files
```
## Writing Style Guidelines
### Structure
- Keep `SKILL.md` under 500 lines (move details to `references/`)
- Use H2 (`##`) for main sections, H3 (`###`) for subsections
- Use bullet points and numbered lists liberally
- Short paragraphs (2-4 sentences max)
### Tone
- Direct and instructional
- Second person ("You are a conversion rate optimization expert")
- Professional but approachable
### Formatting
- Bold (`**text**`) for key terms
- Code blocks for examples and templates
- Tables for reference data
- No excessive emojis
### Clarity Principles
- Clarity over cleverness
- Specific over vague
- Active voice over passive
- One idea per section
### Description Field Best Practices
The `description` is critical for skill discovery. Include:
1. What the skill does
2. When to use it (trigger phrases)
3. Related skills for scope boundaries
```yaml
description: When the user wants to optimize conversions on any marketing page. Use when the user says "CRO," "conversion rate optimization," "this page isn't converting." For signup flows, see signup-flow-cro.
```
## Claude Code Plugin
This repo also serves as a plugin marketplace. The manifest at `.claude-plugin/marketplace.json` lists all skills for installation via:
```bash
/plugin marketplace add coreyhaines31/marketingskills
/plugin install marketing-skills
```
See [Claude Code plugins documentation](https://code.claude.com/docs/en/plugins.md) for details.
## Git Workflow
### Branch Naming
- New skills: `feat/skill-name`
- Improvements: `fix/skill-name-description`
- Documentation: `docs/description`
### Commit Messages
Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
- `feat: add skill-name skill`
- `fix: improve clarity in page-cro`
- `docs: update README`
### Pull Request Checklist
- [ ] `name` matches directory name exactly
- [ ] `name` follows naming rules (lowercase, hyphens, no `--`)
- [ ] `description` is 1-1024 chars with trigger phrases
- [ ] `SKILL.md` is under 500 lines
- [ ] No sensitive data or credentials
## Skill Categories
See `README.md` for the current list of skills organized by category. When adding new skills, follow the naming patterns of existing skills in that category.

1
CLAUDE.md Symbolic link
View File

@@ -0,0 +1 @@
AGENTS.md

91
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,91 @@
# Contributing
Thanks for your interest in contributing to Marketing Skills! This guide will help you add new skills or improve existing ones.
## Requesting a Skill
You can also suggest new skills by [opening a skill request](https://github.com/coreyhaines31/marketingskills/issues/new?template=skill-request.yml).
## Adding a New Skill
### 1. Create the skill directory
```bash
mkdir -p skills/your-skill-name
```
### 2. Create the SKILL.md file
Every skill needs a `SKILL.md` file with YAML frontmatter:
```yaml
---
name: your-skill-name
description: When to use this skill. Include trigger phrases and keywords that help agents identify relevant tasks.
license: MIT
metadata:
author: "[Your Name](https://your-website.com)"
version: "1.0.0"
---
# Your Skill Name
Instructions for the agent go here...
```
### 3. Follow the naming conventions
- **Directory name**: lowercase, hyphens only (e.g., `email-sequence`)
- **Name field**: must match directory name exactly
- **Description**: 1-1024 characters, include trigger phrases
### 4. Structure your skill
```
skills/your-skill-name/
├── SKILL.md # Required - main instructions
├── references/ # Optional - additional documentation
│ └── guide.md
├── scripts/ # Optional - executable code
│ └── helper.py
└── assets/ # Optional - templates, images, data
└── template.json
```
### 5. Write effective instructions
- Keep `SKILL.md` under 500 lines
- Move detailed reference material to `references/`
- Include step-by-step instructions
- Add examples of inputs and outputs
- Cover common edge cases
## Improving Existing Skills
1. Read the existing skill thoroughly
2. Test your changes locally
3. Keep changes focused and minimal
4. Update the version in metadata if making significant changes
## Submitting Your Contribution
1. Fork the repository
2. Create a feature branch (`git checkout -b feat/new-skill-name`)
3. Make your changes
4. Test locally with an AI agent
5. Submit a pull request using the appropriate template:
- [New Skill](?template=new-skill.md)
- [Skill Update](?template=skill-update.md)
- [Documentation](?template=documentation.md)
## Skill Quality Checklist
- [ ] `name` matches directory name
- [ ] `description` clearly explains when to use the skill
- [ ] Instructions are clear and actionable
- [ ] No sensitive data or credentials
- [ ] Follows existing skill patterns in the repo
## Questions?
Open an issue if you have questions or need help with your contribution.

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Corey Haines
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

37
README.md
View File

@@ -166,41 +166,8 @@ You can also invoke skills directly:
Found a way to improve a skill? Have a new skill to suggest? PRs and issues welcome!
**Ideas for contributions:**
- Improve existing skill instructions or frameworks
- Add new experiment ideas or best practices
- Fix typos or clarify confusing sections
- Suggest new skills (open an issue first to discuss)
- Add examples or case studies
**How to contribute:**
1. Fork the repo
2. Edit the skill file(s)
3. Submit a PR with a clear description of what you improved
### Skill File Structure
Each skill is a directory containing a `SKILL.md` file:
```
skills/
skill-name/
SKILL.md
```
The `SKILL.md` file follows this format:
```markdown
---
name: skill-name
description: One-line description for skill selection
---
# Skill Name
[Full instructions for the AI agent]
```
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on adding or improving skills.
## License
MIT - Use these however you want.
[MIT](LICENSE) - Use these however you want.