Cursor rule

1---
2description: Guidelines for creating consistent pull request changelists in markdown format with proper code block formatting
3globs: 
4alwaysApply: false
5---
6---
7description: Updated guidelines for creating consistent pull request changelists in markdown format, ensuring strict raw markdown code block formatting and proper structure.
8globs: "*.md"
9alwaysApply: false
10---
11# Pull Request Changelist Format
12 
13This document outlines strict standards for creating and formatting pull request changelists in markdown. Following these guidelines ensures that the output remains as raw markdown (unrendered) and prevents any issues with Cursor’s markdown rendering.
14 
15<rule>
16name: pull_request_changelist_format
17description: Updated guidelines for creating consistent pull request changelists in markdown with strict code block handling and structured formatting.
18filters:
19  - type: file_extension
20    pattern: "\\.md$"
21  - type: content
22    pattern: "(?i)(pull request|pr|changelist|changelog)"
23 
24actions:
25  - type: suggest
26    message: |
27      ## Updated Pull Request Changelist Guidelines
28 
29      To guarantee clarity and consistency, please adhere to the following time-tested, unambiguous guidelines when requesting a PR changelist from Cursor:
30 
31      ### 1. Request Format
32      **Always explicitly request raw markdown output in a code block** using one of these exact phrases:
33      - "Return markdown as code"
34      - "Return as code inside markdown as code (one block)"
35      - "Provide the markdown in a code block"
36      - "Return the content as a markdown code block, not as formatted text"
37      - "Generate the PR changelist in a markdown code block"
38 
39      Avoid ambiguous wording that could lead to a rendered (formatted) output.
40 
41      ### 2. Expected Response Format
42      Cursor should always respond with a raw markdown code block that looks like:
43```
44      ```markdown
45      # Summary of Changes
46 
47      ## Category Name
48      - Change item
49```
50```
51 
52      ### 3. Handling Incorrect Format
53      If the response is rendered markdown rather than a raw code block, prompt with one of the following:
54      - "Please provide the exact markdown in a code block using triple backticks, not as formatted text."
55      - "I require the raw markdown syntax; reformat your response with triple backticks."
56      - "Reformat your output as a code block enclosed in triple backticks."
57 
58      ### 4. Changelist Structure
59      - **Main Heading:** Must begin with `# Summary of Changes`
60      - **Categories:** Use `##` headings to group related changes.
61      - **Changes:** List each change with a bullet (`-`), starting with a past tense verb (e.g., Added, Updated, Removed).
62      - **Code/Variables:** Enclose module names or configuration settings in backticks (e.g., `module_name`).
63 
64      ### 5. Content Requirements
65      - Be specific about what changed and why.
66      - Group similar changes under the appropriate category headings.
67      - For configuration changes, include both the setting name and its new value.
68      - Keep each entry concise but descriptive.
69 
70      ### 6. Example Command
71      To request a changelist from Cursor, try:
72```
73      Prepare a PR changelist based on these changes. Return the markdown in a code block with triple backticks.
74```
75 
76      Adhering to these traditional, time-tested formatting guidelines not only prevents ambiguity but also paves the way for future improvements in automated changelist generation.
77      
78  - type: validate
79    conditions:
80      - pattern: "^```\\s*markdown\\s*\\n#\\s+Summary\\s+of\\s+Changes"
81        message: "The changelist must be a raw markdown code block starting with '# Summary of Changes'. Ensure the use of triple backticks and correct heading structure."
82      - pattern: "-\\s+(Added|Updated|Removed)\\b"
83        message: "Each bullet point must begin with a past tense verb: 'Added', 'Updated', or 'Removed'."
84      
85examples:
86  - input: |
87      Request: "Create a PR changelist for my changes. Return markdown code as code."
88      
89      Good Response from Cursor:
90      ```markdown
91      # Summary of Changes
92 
93      ## Environment Configuration
94      - Updated `STAGE_FILE_PROXY_URL` to data.safeworkaustralia.gov.au
95      - Updated `LOCALDEV_URL` to dataswa.docker.amazee.io
96 
97      ## Module Changes
98      - Removed `page_cache` module
99      - Added `stage_file_proxy` module
100```
101    output: |
102      This is the correct format for Cursor to return a changelist – as a raw markdown code block enclosed in triple backticks.
103      
104  - input: |
105      Request: "Create a PR changelist for my changes."
106      
107      Bad Response from Cursor (rendered markdown instead of a code block):
108      # Summary of Changes
109 
110      ## Environment Configuration
111      - Updated `STAGE_FILE_PROXY_URL` to data.safeworkaustralia.gov.au
112      - Updated `LOCALDEV_URL` to dataswa.docker.amazee.io
113    output: |
114      This response is incorrectly formatted as rendered markdown. Please ask Cursor to provide the output as a raw markdown code block with triple backticks.
115 
116metadata:
117  priority: medium
118  version: 1.2
119</rule>