Cursor rule

1---
2description:
3globs:
4alwaysApply: false
5---
6# Create a High-Quality Pull Request
7 
8**Your Task: Follow this comprehensive checklist to prepare and create a well-documented, clean, and accurate Pull Request (PR) using the `gh` CLI.**
9 
10## File Existence Check
11 
12Confirm the presence of `.gitignore` and the PR body file location:
13 
14```bash
15ls . docs
16```
17 
18Use this information before running the remaining steps.
19 
200.  **Pre-check: Unstaged Changes**
21    - **Action:** Execute `git status`.
22    - **Review:** Identify any modified or new files relevant to this PR that are not yet staged.
23    - **Stage if Necessary:** If relevant changes are unstaged, use `git add <file>...` or `git add .`.
24    - **Confirm:** Re-run `git status` to ensure all intended changes for this PR are now staged.
25 
261.  **Audit Staged Files (Critical Check)**
27    - **Verify `.gitignore**:** Ensure your project's `.gitignore` file is up-to-date and correctly excludes all unwanted files (e.g., local environment files, build artifacts, logs, secrets).
28    - **Review Staged List:** Execute `git status` again. Meticulously review the final list of files staged for commit.
29    - **Identify Unwanted Files:** Look for any files that should *not* be part of the repository or this specific PR (e.g., secrets, large binaries, temporary files). Standard configuration files like `.vscode/`, `.cursor/`, `.editorconfig` are generally acceptable if intended for the project.
30    - **Remediate if Unwanted Files Found:**
31        - Add/update patterns in `.gitignore` for these files.
32        - Unstage them: `git reset HEAD <file>...`.
33        - If already tracked, remove from Git history: `git rm --cached <file>...`.
34        - For untracked files, ensure they are now ignored or delete them if they are genuinely extraneous.
35    - **Final Confirmation:** Run `git status` one last time. Verify that *only* the intended and appropriate files remain staged.
36 
372.  **Draft Pull Request Body**
38    - **Create/Update PR Body File:** Prepare the PR description in a file named `docs/pr/pr-body-file-<branch-name>.md` (replace `<branch-name>` with your current Git branch name).
39    - **Structure for Clarity:** Use Markdown with clear headings:
40        - `## Summary`
41        - `## Key Changes`
42        - `## Testing Done` (or `## How to Verify`)
43        - `## Related Issues` (e.g., `Fixes #123`, `Closes #456`, `Addresses #789`)
44    - **Lead with the Goal:** The `Summary` should start with a concise statement of the PR's primary purpose and impact.
45    - **Detail Key Changes:** Under `Key Changes`, use bullet points (`- `) to list significant additions, fixes, or features. Be specific about files or modules affected if it aids understanding.
46    - **Provide Context & Rationale:** Briefly explain the 'why' behind the changes. Link to issue trackers or design documents if applicable.
47    - **Describe Verification:** Under `Testing Done`, detail the testing performed (unit, integration, manual steps). If manual verification is needed by reviewers, provide clear, actionable steps.
48    - **Save:** Ensure the PR body file is saved.
49 
503.  **Execute Project Update Rules (If Applicable)**
51    - **Consult Rules:** Locate and carefully read the `./cursor/rules/project-update-rules.mdc` file.
52    - **Follow Instructions:** Execute all instructions specified within that file precisely, if they are relevant before a PR creation.
53 
544.  **Create Pull Request with `gh` CLI**
55    - **Push Branch (if not already done):** Ensure your local branch is pushed to the remote: `git push -u origin <branch-name>`.
56    - **Construct `gh pr create` Command:**
57        - Use a clear, concise title: `--title "type: Short description of main change"` (e.g., `feat: Implement user authentication flow`). Follow conventional commit message standards if the project uses them.
58        - Specify the drafted body file: `--body-file docs/pr/pr-body-file-<branch-name>.md`.
59        - Consider `--fill` to use commit messages for PR title and body if appropriate for simple PRs and your workflow allows.
60    - **Execute:** Run `gh pr create ...` with your prepared options.
61    - **Review `gh` Output:** Carefully check the preview of the title and body provided by `gh pr create` before final submission. Ensure it is accurate, clear, and complete.
62 
63**Example `gh pr create` command:**
64 
65```bash
66# Ensure branch is pushed first: git push -u origin fix-label-sanitization
67gh pr create --title &quot;fix: Enforce normalized, dash-separated, lowercase labels&quot; --body-file docs/pr/pr-body-file-fix-label-sanitization.md
68```
69 
70After creating the pull request, give a concise executive summary of the key changes and tests so reviewers know what to expect. Keep this summary separate from the PR body file.
71 
72**REMEMBER: The objective is to create a meticulously prepared Pull Request. This includes clean commits, a descriptive title, a comprehensive body, and adherence to any project-specific pre-PR checks. A high-quality PR facilitates easier review and smoother integration.**
73