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

Update AI Editor rules files with detailed PlatformPlatform conventions #671

Merged

Conversation

tjementum
Copy link
Member

@tjementum tjementum commented Jan 10, 2025

Summary & Motivation

Enhance the GitHub and Cursor rules files to make them more specific to PlatformPlatform's conventions. This update includes detailed examples and explanations of key concepts such as the usage of CQRS, Strongly Typed IDs, and other important architectural patterns. The added specificity ensures better adherence to PlatformPlatform's development standards and provides clearer guidance for contributors.

The file is now just above 6 KB, which is the maximum for the Windsurf AI editor, while Cursor AI seems to allow for larger rule files.

Checklist

  • I have added tests, or done manual regression tests
  • I have updated the documentation, if necessary

@tjementum tjementum added the Enhancement New feature or request label Jan 10, 2025
@tjementum tjementum self-assigned this Jan 10, 2025
@tjementum tjementum requested a review from a team as a code owner January 10, 2025 20:57
Copy link

linear bot commented Jan 10, 2025

@tjementum tjementum merged commit 5181fc7 into main Jan 10, 2025
3 checks passed
@tjementum tjementum deleted the pp-301-update-rules-with-platformplatform-conventions branch January 10, 2025 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant