My Jetpack: Add CLAUDE.md file

[gmjuhasz]

Fixes MYJP-204

Proposed changes:

• Adds a project level Claude md file for Claude code

Other information:

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

• Sanity check of the file that it makes sense
• You could try using Claude Code to see if it recognises the file, but that should be the case

[Copilot]

Pull Request Overview

This PR introduces a new CLAUDE.md file at the project level to provide guidance for Claude Code interactions, and adds a corresponding changelog entry.

• Adds projects/packages/my-jetpack/changelog/add-my-jetpack-project-level-claude-md
• Adds detailed projects/packages/my-jetpack/CLAUDE.md documentation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
projects/packages/my-jetpack/changelog/add-my-jetpack-project-level-claude-md	Changelog entry for the new CLAUDE.md file
projects/packages/my-jetpack/CLAUDE.md	Guidance and patterns for using Claude Code with this repository

Comments suppressed due to low confidence (1)

projects/packages/my-jetpack/CLAUDE.md:18

• Grammar: change 'Must be ran' to 'Must be run' for clarity.

pnpm run test # Runs the REACT component tests. Must be ran from my-jetpack folder

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the add/my-jetpack/project-level-claude-md branch.
• To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/my-jetpack/project-level-claude-md

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  
• ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
3. You can use GitHub's Reviewers functionality to request a review.
4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

[jp-launch-control]

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

[gmjuhasz]

Thanks for the comments @jeherve, these are great ideas! I implemented them in 581af31. I linked documentations where applicable, and moved basic information over to my-jetpack's README

[tbradsha]

I don't know anything about the general conventions here, but a few general thoughts if we go this route:

1. We should probably exclude CLAUDE.md from production in the monorepo root .gitattributes.
2. The README.md target audience would typically be those that are downloading the package, and would be exposed in Packagist and the mirror repo. As such, relative references to files outside of this package is probably a bad idea, as those links would be broken. Those limitations shouldn't apply to CLAUDE.md if we implement item 1.