Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The primary aim is to offer a comprehensive, AI-friendly knowledge base and star
## Core Components
The core components of this repository are the README and markdown files found throughout the project. These files provide indexed documentation, guidelines, and best practices to support AI-assisted PatternFly development, regardless of which AI coding tool you use.

- **Table of Contents:** See [`.pf-ai-documentation/README.md`](documentation/README.md) for a full table of contents and navigation to all rules, guides, and best practices.
- **Table of Contents:** See [`.pf-ai-documentation/README.md`](.pf-ai-documentation/README.md) for a full table of contents and navigation to all rules, guides, and best practices.

## Using This Documentation with Cursor and AI Tools

Expand Down Expand Up @@ -52,6 +52,14 @@ To get the full benefit of these docs and rules:
> 3. Save and restart your client/editor.
> 4. For more details and setup instructions for other editors, see the official guide: https://github.com/upstash/context7#installation

## Claude Code plugins

For [Claude Code](https://code.claude.com) users, this repository includes plugins with agents for PatternFly development.

See [`claude-code/`](claude-code/) for available plugins and installation instructions.

---

## Reference Documentation
- [PatternFly.org](https://www.patternfly.org/)
- [PatternFly React GitHub Repository](https://github.com/patternfly/patternfly-react)
Expand Down
13 changes: 13 additions & 0 deletions claude-code/.claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"name": "patternfly-ai-coding",
"owner": {
"name": "PatternFly Team"
},
"plugins": [
{
"name": "pf-react",
"source": "./plugins/pf-react",
"description": "PatternFly React coding standards and test generation agents"
}
]
}
83 changes: 83 additions & 0 deletions claude-code/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# PatternFly Claude Code Resources

This directory contains [Claude Code](https://code.claude.com) resources for PatternFly development.

## Available resources

### Plugins
- **[pf-react](plugins/pf-react/)** - Coding standards and test generation agents for PatternFly React

---

## Installing plugins

### pf-react plugin

Once installed, these agents work across all your projects:

```bash
# 1. Add the PatternFly marketplace
/plugin marketplace add patternfly/patternfly-ai-coding

# 2. Install the plugin
/plugin install pf-react@patternfly-ai-coding
```

Done! The agents are now available globally.

## Using the agents

Use these agents from any project directory:

```bash
cd ~/my-patternfly-app # Any project directory
claude

# Use the agents
/coding-standards # PatternFly React coding standards
/test-generator # Generate tests for components
```

## What's included

The `pf-react` plugin provides two agents:

### coding-standards
PatternFly v6 React coding standards based on official PatternFly guidelines:
- Component composition patterns
- Design token usage
- Accessibility requirements (WCAG 2.1 Level AA)
- React and TypeScript best practices
- Testing standards

### test-generator
Unit test generation following Testing Library best practices:
- User behavior testing over implementation details
- Accessibility testing patterns
- Semantic queries and OUIA guidelines
- Proper mocking patterns

## Updating

Get the latest version:

```bash
/plugin marketplace update patternfly-ai-coding
/plugin install pf-react@patternfly-ai-coding
```

## How it works

- **One-time install** - Add marketplace and install plugin (done once)
- **Global availability** - Agents work in any project directory after installation
- **No project setup needed** - Just run `/coding-standards` or `/test-generator` from any project
- **Direct from GitHub** - No need to clone the repository

## Sources

The agents are based on:
- [PatternFly.org](https://www.patternfly.org/) official documentation
- [PatternFly React CONTRIBUTING.md](https://github.com/patternfly/patternfly-react/blob/main/CONTRIBUTING.md)
- [PatternFly React Testing Wiki](https://github.com/patternfly/patternfly-react/wiki/React-Testing-Library-Basics,-Best-Practices,-and-Guidelines)
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) official documentation
- [React.dev](https://react.dev/learn) official documentation
11 changes: 11 additions & 0 deletions claude-code/plugins/pf-react/.claude-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "pf-react",
"description": "PatternFly React coding standards and test generation agents",
"version": "1.0.0",
"author": {
"name": "PatternFly Team",
"url": "https://www.patternfly.org"
},
"repository": "https://github.com/patternfly/patternfly-ai-coding",
"license": "MIT"
}
Loading