docs(rules): improve PR template and add commit guide #3349
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheSonOfThomp
requested review from
adamrasheed,
Copilot and
stephl3
and removed request for
a team
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances cursor rules for better PR and commit message generation. It improves the PR template with clearer formatting, removes an outdated tsconfig checklist item, and adds comprehensive commit message guidance following conventional commits with a 50-character limit.
Key changes:
- Updated PR generation template with improved formatting and better JIRA ticket extraction instructions
- Removed outdated "add to global tsconfig" checklist item for new components
- Added new commit message generation guide with conventional commits format and examples
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.cursor/rules/generate-pull-request-details.mdc |
Enhanced PR template formatting, improved JIRA extraction guidance, removed outdated tsconfig checklist item |
.cursor/rules/generate-commit-message.mdc |
New file providing comprehensive conventional commit message generation guidance with 50-char limit |
| type(scope): subject | ||
| ``` | ||
|
|
||
| **Maximum length: 50 characters total** |
There was a problem hiding this comment.
[nitpick] The 50-character limit is mentioned but may be overly restrictive for commit messages in this repository. Consider documenting whether this includes or excludes the type and scope, as type(scope): alone can consume 15+ characters, leaving very limited space for the subject.
Collaborator
There was a problem hiding this comment.
whoa its doing nits now 🤯
Contributor
|
Size Change: 0 B Total Size: 1.8 MB ℹ️ View Unchanged
|
Contributor
|
Coverage after merging at/cursor-settings into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✍️ Proposed changes
This PR enhances the cursor rules documentation by improving the PR generation template and adding a new commit message generation guide. The changes to
generate-pull-request-details.mdcinclude better formatting, clearer instructions for JIRA ticket extraction, and an updated checklist for new components (removing the outdated tsconfig requirement). The newgenerate-commit-message.mdcfile provides comprehensive guidance for creating conventional commit messages with a 50-character limit, complete with examples and best practices.🎟️ Jira ticket: N/A
✅ Checklist
pnpm changesetand documented my changes🧪 How to test changes
generate-pull-request-detailscursor rule with@Branchcontext to verify the PR template generates correctlygenerate-commit-messagecursor rule with staged changes to verify commit messages follow the conventional format