Skip to content

docs: fix CLAUDE.md file paths and README.md installation instructions#5

Merged
wzul merged 1 commit into
mainfrom
fix/docs-file-paths-and-readme
Jun 2, 2026
Merged

docs: fix CLAUDE.md file paths and README.md installation instructions#5
wzul merged 1 commit into
mainfrom
fix/docs-file-paths-and-readme

Conversation

@wzul

@wzul wzul commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

What does this change?

This PR corrects documentation inaccuracies in CLAUDE.md and README.md to align with the actual project structure and improve user onboarding.

Key changes include:

  • File Path Corrections: Updated CLAUDE.md to use the correct filenames for core components (e.g., prefixing files with chip-givewp- and adjusting the block gateway class names) to match the actual codebase.
  • Component Documentation: Added descriptions for missing form-builder script components (Chip_Givewp_Enqueue_Form_Builder_Scripts and its associated JS).
  • Dependency Updates: Expanded the Composer dev dependencies list to include PHPCS/WPCS packages used for code quality.
  • Onboarding Clarity: Updated README.md to 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

  1. Verify Paths: Cross-reference the updated file paths in CLAUDE.md against the repository's file system (e.g., check that includes/class-chip-givewp-api.php exists while includes/class-api.php does not).
  2. Verify README: Read the "Installation" section of the README.md to ensure the flow is logical for a new user.
  3. Verify Links: Ensure the GitHub download link and WordPress.org link in README.md are functional.

Potential Risks & Review Items

  • Documentation Drift: While this fixes existing inaccuracies, care should be taken in future PRs to update CLAUDE.md if files are renamed again.
  • Zero Runtime Risk: This PR only modifies Markdown files; there is no impact on plugin functionality.

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

  • Unit tests provided? (N/A)
  • All tests passing?
  • Tested in staging?
  • Task link provided?

- 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>
@wzul wzul merged commit c78c62b into main Jun 2, 2026
10 checks passed
@wzul wzul deleted the fix/docs-file-paths-and-readme branch June 2, 2026 12:55
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.

1 participant