Skip to content

Commit ed3287e

Browse files
committed
Update pull-request-rules.mdc
1 parent 010075e commit ed3287e

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

pull-request-rules.mdc

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ When creating or updating a pull request, follow these guidelines:
1414
2. Run `git --no-pager diff` to compare the current branch with origin default branch
1515
3. Analyze the changes to understand the purpose and impact
1616

17+
## Pull Request Types
18+
19+
- `fix`: Patches a bug in your codebase (correlates with PATCH in Semantic Versioning)
20+
- `feat`: Introduces a new feature to the codebase (correlates with MINOR in Semantic Versioning)
21+
- `BREAKING CHANGE`: Introduces a breaking API change (correlates with MAJOR in Semantic Versioning)
22+
- Other allowed types: `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`
23+
24+
## Specification Details
25+
26+
1. Title MUST be prefixed with a type, followed by an OPTIONAL scope, OPTIONAL !, and REQUIRED terminal colon and space
27+
2. The type `feat` MUST be used when adding a new feature
28+
3. The type `fix` MUST be used when fixing a bug
29+
4. A scope MAY be provided after a type, surrounded by parenthesis (e.g., `fix(parser):`)
30+
1731
## Pull Request Format
1832
- Title: One sentence summary (max 120 characters)
1933
- Body:
@@ -23,7 +37,7 @@ When creating or updating a pull request, follow these guidelines:
2337

2438
## Example:
2539
```
26-
Title: Add user authentication to login page
40+
feat: Add user authentication to login page
2741

2842
Body:
2943
- Add password validation function
@@ -39,16 +53,12 @@ When creating a PR, ensure that:
3953
- All bullet points are written without extra lines between them
4054
- The body starts directly with bullet points (no introductory text)
4155
- When using GitHub CLI, use `--body-file` instead of `--body` to avoid escape character issues
42-
- Always create the PR body file in the `.cursor/tmp/` folder (e.g., `.cursor/tmp/pr-body.md`)
56+
- Always create the PR body file in the `/tmp/` folder (e.g., `/tmp/pr-body.md`)
4357
In GitHub or similar platforms, preview the PR description to verify there are no unwanted
4458
line breaks between bullet points.
4559

4660
## Process
47-
1. Analyze changes between master and current branch
61+
1. Analyze changes between main and current branch
4862
2. Create PR title and bullet list description
4963
3. Create new PR or update existing PR tied to current branch
5064
4. Request review if needed
51-
5. Remove any temporary files created during the process
52-
53-
## Important
54-
Always create temporary files in the `.cursor/tmp/` folder and clean them up (like `.cursor/tmp/pr-body.md`) after completing the PR process to avoid cluttering the workspace.

0 commit comments

Comments
 (0)