Skip to content

@W-18737391 Add development guidelines and page creation rules for generated project#2786

Merged
yhsieh1 merged 15 commits intofeature/generated-project-cursor-rulesfrom
feature/W-18737391/updateCursorRules
Jul 14, 2025
Merged

@W-18737391 Add development guidelines and page creation rules for generated project#2786
yhsieh1 merged 15 commits intofeature/generated-project-cursor-rulesfrom
feature/W-18737391/updateCursorRules

Conversation

@yhsieh1
Copy link
Contributor

@yhsieh1 yhsieh1 commented Jul 11, 2025

Description

  • Simplify and condense development guidelines to remove unnecessary information and not confuse Cursor
  • Add page creation rules to help Cursor create page with route and create a clean start point when creating a simple new page

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

Changes

  • (change1)

How to Test-Drive This PR

  • (step1)

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

@yhsieh1 yhsieh1 requested a review from a team as a code owner July 11, 2025 00:05
@cc-prodsec
Copy link
Collaborator

cc-prodsec commented Jul 11, 2025

🎉 Snyk checks have passed. No issues have been found so far.

security/snyk check is complete. No issues have been found. (View Details)

license/snyk check is complete. No issues have been found. (View Details)

@yhsieh1 yhsieh1 added the skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated label Jul 11, 2025
@yhsieh1 yhsieh1 changed the base branch from develop to feature/generated-project-cursor-rules July 11, 2025 13:08
Copy link
Contributor

@snilakandan13 snilakandan13 left a comment

Choose a reason for hiding this comment

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

Looks good

@yhsieh1 yhsieh1 requested review from bendvc and wei-liu-sf July 11, 2025 15:31
Copy link
Contributor

Choose a reason for hiding this comment

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

How does this model-definition configuration file get discovered?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cursor only fetch this guidelines rule if it think it needs it. On top of that, Cursor will not look into nodes_module even rules say so. We need other mechanism to expose model-definition files. By the way, I do not know where it is as well. Could you share more information about it?

Copy link
Contributor

@snilakandan13 snilakandan13 Jul 14, 2025

Choose a reason for hiding this comment

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

Moreover mdc files are a cursor's convention in determining rules
https://docs.cursor.com/context/rules#project-rules
This is more like a metadata content file used by cursor internally when agent is requested to perform tasks

Copy link
Contributor

@snilakandan13 snilakandan13 left a comment

Choose a reason for hiding this comment

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

Why do we need to add in the template directory

@@ -0,0 +1,8 @@
---
Copy link
Contributor Author

@yhsieh1 yhsieh1 Jul 14, 2025

Choose a reason for hiding this comment

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

Copy over rules to storefront-development name space from pwa-kit-create-app/assets/cursor-rules so that it also benefits pwa kit template development.

@yhsieh1 yhsieh1 merged commit e4827e3 into feature/generated-project-cursor-rules Jul 14, 2025
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip changelog Skip the "Changelog Check" GitHub Actions step even if the Changelog.md files are not updated

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants