You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(prompts): standardize PR description format for automated releases
- Updated /pr prompt to use consistent ordered list structure
- PR descriptions now follow: 1) summary paragraph, 2) issue links, 3) detailed sections
- Added clear guidance for release note formatting
- Included example structure to illustrate proper format
Fixes#218
Copy file name to clipboardExpand all lines: .github/prompts/pr.prompt.md
+53-12Lines changed: 53 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,22 +69,60 @@ $ARGUMENTS
69
69
5.**Generate PR title**:
70
70
-**If issue title retrieved**: Use format `<Icon> <Issue Title>`
71
71
- Examples:
72
-
-`🚀 Add support for custom module templates`
72
+
-`🚀 [Feature]: Add support for custom module templates`
73
73
-`🪲 [Fix]: Resolve null reference in parameter validation`
74
74
-`📖 [Docs]: Update installation guide with prerequisites`
75
75
76
76
6.**Generate release note style description**:
77
-
- Start with a concise summary paragraph describing **what changes for the user** of the code
78
-
- Focus on user-facing impact, not implementation details
77
+
- The PR description will be used automatically as the release note in an automated release
78
+
- Use this exact structure (ordered list format):
79
+
80
+
**1. Leading Paragraph (Summary)**
81
+
- Write a concise paragraph describing **what changes for the user** of the solution
82
+
- Focus on user-facing value and impact, not implementation details
79
83
- Use present tense and active voice
80
-
- Structure:
81
-
***Leading paragraph**: Clear summary of the change and its benefit to users
82
-
***If issue linked**: Add `- Fixes #<issue-number>` after the leading paragraph
83
-
***Optional additional context**: Briefly explain why this change was needed
84
-
***What's Changed**: Bullet points of key changes (user-facing)
85
-
- Keep it concise - this should read like a release note entry
86
-
- DO NOT add a title or heading before the leading paragraph
87
-
- Avoid implementation details unless necessary for understanding
84
+
- Audience: Users of the solution (not developers)
85
+
86
+
**2. Issue Links (Unordered List)**
87
+
- Add one or more issue links as unordered list items
88
+
- Format: `- Fixes #<issue-number>`
89
+
- If multiple issues: `- Fixes #<issue-1>`, `- Fixes #<issue-2>`
90
+
91
+
**3. Details (Sections with Headers)**
92
+
- For each significant change, add a header (e.g., `## Configuration`, `## Breaking Changes`, `## Usage`)
93
+
- Under each header, provide:
94
+
* Details of what changed
95
+
* What the user needs to change or do differently (if anything)
96
+
* Examples or code snippets if helpful for understanding
97
+
- Keep sections concise and user-focused
98
+
- Avoid implementation details unless necessary for user understanding
99
+
100
+
**Example Structure:**
101
+
````markdown
102
+
The workflow now provides fine-grained control over repository linting behavior through simple configuration options. You can disable the linter entirely or customize which validations run by configuring super-linter environment variables directly in your settings file.
103
+
104
+
- Fixes #218
105
+
106
+
## Configure settings for repository linting
107
+
108
+
You can now control the linter behavior via the `Linter` section in your `.settings.yml` file. This allows you to skip linting altogether or customize which validations are performed.
109
+
110
+
Added `Linter.Skip` and `Linter.env` settings to control linter behavior. You can now disable the linter entirely or customize which validations run.
111
+
112
+
To disable the linter:
113
+
```yaml
114
+
Linter:
115
+
Skip: true
116
+
```
117
+
118
+
To customize validations:
119
+
```yaml
120
+
Linter:
121
+
env:
122
+
VALIDATE_JSCPD: false
123
+
```
124
+
125
+
````
88
126
89
127
7.**Create or update the pull request**:
90
128
-**Check if PR already exists** for this branch in the **target repository** (upstream in fork mode, origin otherwise)
@@ -131,4 +169,7 @@ $ARGUMENTS
131
169
- In origin mode, all operations use the `origin` repository
132
170
- The PR is always created as a draft to allow for review before marking as ready
133
171
- Labels can be manually adjusted after PR creation if needed
134
-
- The description should be written from the user's perspective, focusing on impact not implementation
172
+
- **The PR description uses a structured format designed for automated release notes**:
173
+
1. Leading paragraph (user-focused summary)
174
+
2. Issue links (unordered list)
175
+
3. Details (sections with headers explaining changes and user actions needed)
0 commit comments