Skip to content

Conversation

@MarkShawn2020
Copy link

@MarkShawn2020 MarkShawn2020 commented Nov 6, 2025

Summary

  • Added comprehensive AI development guidance documentation
  • CLAUDE.md: Detailed documentation for Claude Code and AI-assisted development
  • AGENTS.md: Repository guidelines for ChatGPT and other AI agents
  • Provides architecture overview, build commands, and development patterns

Changes

CLAUDE.md

Comprehensive documentation for Claude Code including:

  • Build & development commands
  • Architecture overview (plugin structure, rules system, testing)
  • Step-by-step guide for creating new rules
  • Common patterns and utilities
  • Build system configuration

AGENTS.md

Concise repository guidelines for AI agents including:

  • Project structure and module organization
  • Build, test, and development commands
  • Coding style and naming conventions
  • Testing guidelines
  • Commit and PR requirements

Benefits

  • Reduces onboarding time for AI-assisted development
  • Provides centralized documentation of project architecture
  • Documents non-obvious patterns that require reading multiple files
  • Helps maintain consistency when adding new rules
  • Supports both Claude Code and ChatGPT workflows

Test plan

  • Verified all documented commands work correctly
  • Confirmed build process documentation is accurate
  • Validated architecture descriptions match codebase

🤖 Generated with Claude Code

@MarkShawn2020 MarkShawn2020 changed the title feat: Add CLAUDE.md for AI development guidance feat: Add AI development guidance (CLAUDE.md & AGENTS.md) Nov 6, 2025
@pjkaufman
Copy link
Collaborator

@MarkShawn2020 , thanks for taking the time to open a PR. At this time, I am not sure I would want this in the plugin repo. I am still undecided on whether or not AI should be endorsed for use in the plugin. My experience is pretty mixed with AI. I am not saying you cannot use it. But I am saying at this time, I think it should be up to the contributor if they want to use it. They can generate this locally as needed in that case. Since I am undecided, I don't think merging this at this time will happen. But if it helps you, feel free to use it for any changes you may contribute.

@pjkaufman
Copy link
Collaborator

I am going to close this for now as I don't know that I have a use for the AI documentation files. If we revisit encouraging the use of AI for work on this repo, then it may be reopened later.

@pjkaufman pjkaufman closed this Nov 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants