Skip to content

For developers and AI agents who want to build PatternFly applications using the latest best practices, with AI assistance (Cursor, Copilot, ChatGPT, etc.).

License

Notifications You must be signed in to change notification settings

patternfly/patternfly-ai-coding

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PatternFly AI Helpers

AI coding helpers for PatternFly development. This repository provides plugins, rules, and documentation to help AI tools (Claude Code, Cursor, Copilot, etc.) generate accurate, best-practice PatternFly applications.

Quick Start

Claude Code

# Add the marketplace
/plugin marketplace add patternfly/ai-helpers

# Install the PatternFly React plugin
/plugin install pf-react@ai-helpers

After installation, use the commands in any project:

/coding-standards    # PatternFly v6 React coding standards
/test-generator      # Generate unit tests following Testing Library best practices

See plugins/pf-react/ for full documentation.

Cursor

Copy the .cursor/rules/ directory into your project to enable PatternFly best-practice enforcement.

Other AI Tools

Copy the docs/ directory into your project workspace. AI tools index local files for context, so having the documentation present locally ensures accurate PatternFly guidance.

Repository Structure

ai-helpers/
├── plugins/              # Claude Code plugins
│   └── pf-react/         # PatternFly React coding standards & test generation
├── docs/                 # AI-friendly PatternFly documentation
│   ├── guidelines/       # Coding standards, styling, accessibility
│   ├── components/       # Component-specific patterns
│   ├── charts/           # Chart guidelines
│   └── chatbot/          # Chatbot patterns
├── .cursor/rules/        # Cursor IDE rules
├── .claude-plugin/       # Plugin marketplace configuration
└── .claude/              # Claude Code settings

Documentation

The docs/ directory contains comprehensive, AI-friendly PatternFly documentation. See docs/README.md for the full table of contents.

Using Documentation with AI Tools

AI tools only index files present in your local workspace. To get the full benefit:

  1. Clone or copy this repository (or at least the docs/ directory) into your project
  2. Open your project in your AI coding tool
  3. The tool will automatically reference the documentation for PatternFly guidance

Contributing

See CONTRIBUTING.md for guidelines on adding plugins, commands, documentation, and Cursor rules.

References

License

MIT

About

For developers and AI agents who want to build PatternFly applications using the latest best practices, with AI assistance (Cursor, Copilot, ChatGPT, etc.).

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •