Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tooling: Cursor rule cleanup #41786

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

tbradsha
Copy link
Contributor

The Cursor rules appear to have recursion issues when attempting to reference another file (e.g. jetpack/jetpack/jetpack/jetpack/jetpack/.github/versions.sh is nonsense). This fixes those links and clarifies a few other items (e.g. coding standards are not identical to WP coding standards).

Cursor's documentation has the following:

Use @file in your project rules to include them as context when the rule is applied.

I've updated references to monorepo files to use the @path/to/file syntax; hopefully that's what it means. It doesn't seem Cursor has awareness of its own rules in the limited time I tried to ask it questions.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

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

Testing instructions:

Do the changes make sense?

@tbradsha tbradsha added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial labels Feb 13, 2025
@tbradsha tbradsha requested review from lezama, jeherve and a team February 13, 2025 14:54
@tbradsha tbradsha self-assigned this Feb 13, 2025
Copy link
Contributor

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 Team 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 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@@ -18,4 +18,4 @@ The “Significance” header specifies the significance of change in the style
The “Type” header categorizes the change in the changelog. In Jetpack, for example, our changelog divides changes into “Major Enhancements”, “Enhancements”, “Improved compatibility”, and “Bugfixes”.
Type must be "security", "added", "changed", "deprecated", "removed", or "fixed"

The body is separated from the headers by a blank line, and is the text that actually goes into the changelog. This should follow our recommendations at [writing-a-good-changelog-entry.md](mdc:jetpack/jetpack/jetpack/docs/writing-a-good-changelog-entry.md).
The body is separated from the headers by a blank line, and is the text that actually goes into the changelog. This should follow our recommendations at @docs/writing-a-good-changelog-entry.md.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That doesn't seem to work for me. Cursor seems to want that markdown link with that special mdc: format. It doesn't recognize the link otherwise.

I'm not sure where that mulitple jetpack comes from though ; when I create the link today I only get one jetpack.

@kraftbj
Copy link
Contributor

kraftbj commented Feb 13, 2025

hopefully that's what it means. It doesn't seem Cursor has awareness of its own rules in the limited time I tried to ask it questions.

Cursor Rules seem like they're implemented oddly. You have to tell the agent to follow the rules for it to follow the rules by specifically bringing a rule into context. It sounds like they see the system as library where you can "check out" the rules that are needed and ignore the rest.

Makes it a lot less useful than I was hoping, but alas.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants