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

Cursor: Add API reuse and code pattern guidelines to development documentation #41629

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from

Conversation

lezama
Copy link
Contributor

@lezama lezama commented Feb 7, 2025

Proposed changes:

  • Added new "API and Package Reuse" section to encourage better code reuse practices
    • Package assessment guidelines
    • Reuse strategy recommendations
    • Integration guidelines
    • Performance considerations
  • Added new "Code Patterns and Readability" section to improve code consistency
    • Pattern consistency guidelines
    • Pull request clarity standards
    • Code organization best practices
    • Documentation alignment requirements
  • Enhanced existing development guidelines to promote:
    • More efficient code reuse across the monorepo
    • Consistent development patterns
    • Better PR readability
    • Clearer documentation standards

Testing instructions:

  • Generally to use it in Cursor.

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

No.

@lezama lezama requested review from jeherve, oskosk and a team February 7, 2025 11:08
Copy link
Contributor

github-actions bot commented Feb 7, 2025

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!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Feb 7, 2025
Copy link
Member

@jeherve jeherve left a comment

Choose a reason for hiding this comment

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

I like the idea of pushing for leveraging existing things instead of reinventing the wheel! 👍

.cursor/rules/development-guidelines.mdc Outdated Show resolved Hide resolved
@kraftbj kraftbj added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants