Skip to content

Commit f6272d3

Browse files
committed
fix: remove conventional commits styling from response format requirements
1 parent 1b4821a commit f6272d3

File tree

7 files changed

+15
-14
lines changed

7 files changed

+15
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ There are three special template strings that `cfme` recognizes by default:
275275

276276
- `<__GIT_DIFF__>` (required): Replaced with the output of `git diff --cached`
277277
(i.e. the staged changes)
278-
- `<__RESPONSE__REQUIREMENTS__>` (required): Replaced with a list of requirements
278+
- `<__RESPONSE_FORMAT_REQUIREMENTS__>` (required): Replaced with a list of requirements
279279
that dictates how the AI should format its response. This is essential so
280280
that `cfme` can parse the AI's response.
281281
Note that these requirements merely dictate the format of the response, they

defaults/prompts/conventional-commits/default.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ You are an expert at creating git commit messages according to the Conventional
1313
```
1414

1515
- Make sure to follow Conventional Commits:
16+
- A header is REQUIRED and must follow the format: `<required type>(<optional scope>): <required description>`
1617
- type MUST match one of the types provided
1718
- scope is OPTIONAL
1819
- breaking changes can be indicated with ! in header or BREAKING CHANGE in footer
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
<**RESPONSE_FORMAT_REQUIREMENTS**>
2-
<**GIT_DIFF**>
1+
<__RESPONSE_FORMAT_REQUIREMENTS__>
2+
<__GIT_DIFF__>
33
LINE_1
4-
<**VAR1**>
4+
<__VAR1__>
55
LINE2
6-
<**VAR2**>
6+
<__VAR2__>
77
LINE3
8-
<**VAR3**>
9-
<**INSTRUCTIONS**>
8+
<__VAR3__>
9+
<__INSTRUCTIONS__>

spec/samples/sample-rendered-prompt-with-instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**Requirements:**
1+
**Response Format Requirements:**
22

33
- Each commit message MUST include a 'header'.
44
- Optionally include 'body' and 'footer', ONLY if a 'header'
@@ -8,7 +8,7 @@
88

99
```yaml
1010
commitMessages:
11-
- header: "<type>[optional scope]: <description>"
11+
- header: "<required header>"
1212
body: "<optional body>"
1313
footer: "<optional footer>"
1414
score: <integer 0-100 representing confidence that this is the best commit message>

spec/samples/sample-rendered-prompt-without-instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**Requirements:**
1+
**Response Format Requirements:**
22

33
- Each commit message MUST include a 'header'.
44
- Optionally include 'body' and 'footer', ONLY if a 'header'
@@ -8,7 +8,7 @@
88

99
```yaml
1010
commitMessages:
11-
- header: "<type>[optional scope]: <description>"
11+
- header: "<required header>"
1212
body: "<optional body>"
1313
footer: "<optional footer>"
1414
score: <integer 0-100 representing confidence that this is the best commit message>

spec/samples/sample-response-requirements.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**Requirements:**
1+
**Response Format Requirements:**
22

33
- Each commit message MUST include a 'header'.
44
- Optionally include 'body' and 'footer', ONLY if a 'header'
@@ -8,7 +8,7 @@
88

99
```yaml
1010
commitMessages:
11-
- header: "<type>[optional scope]: <description>"
11+
- header: "<required header>"
1212
body: "<optional body>"
1313
footer: "<optional footer>"
1414
score: <integer 0-100 representing confidence that this is the best commit message>

src/lib/load_vars_map.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ load_vars_map() {
4848
4949
```yaml
5050
commitMessages:
51-
- header: "<type>[optional scope]: <description>"
51+
- header: "<required header>"
5252
body: "<optional body>"
5353
footer: "<optional footer>"
5454
score: <integer 0-100 representing confidence that this is the best commit message>

0 commit comments

Comments
 (0)