docs: fix CLAUDE.md file paths and README.md installation instructions#5
Merged
Conversation
- Correct all incorrect file paths in CLAUDE.md to use actual class-chip-givewp-* filenames - Add missing form-builder script components to CLAUDE.md - Expand Composer dev dependencies list to include PHPCS packages - Fix README.md installation instructions to clarify the zip is CHIP for GiveWP, not GiveWP itself Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this change?
This PR corrects documentation inaccuracies in
CLAUDE.mdandREADME.mdto align with the actual project structure and improve user onboarding.Key changes include:
CLAUDE.mdto use the correct filenames for core components (e.g., prefixing files withchip-givewp-and adjusting the block gateway class names) to match the actual codebase.Chip_Givewp_Enqueue_Form_Builder_Scriptsand its associated JS).README.mdto explicitly state that GiveWP is a prerequisite and clarified that the zip file provided is the gateway plugin, not the core GiveWP plugin.How to test
CLAUDE.mdagainst the repository's file system (e.g., check thatincludes/class-chip-givewp-api.phpexists whileincludes/class-api.phpdoes not).README.mdto ensure the flow is logical for a new user.README.mdare functional.Potential Risks & Review Items
CLAUDE.mdif files are renamed again.Is this PR safe for automatic approval?
Yes. This is a documentation-only update that synchronizes developer/user guides with the existing codebase.
Images
N/A
Related Tasks / PRs
🤖 Generated with Claude Code
Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com
Checklist