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
Copy file name to clipboardExpand all lines: .github/prompts/update-user-messages.prompt.md
+25-2Lines changed: 25 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
mode: 'edit'
3
3
description: 'Update user messages'
4
+
model: Claude Sonnet 3.5
4
5
---
5
6
6
7
This prompt guide is for updating user-facing messages in ${file} or ${selection}
@@ -43,7 +44,17 @@ When modifying user messages, follow **as close as possible** these rules:
43
44
user_message("Unable to load project.", _version=1)
44
45
```
45
46
46
-
3.**Message Style**: Follow **strictly** the guidelines in `${workspaceFolder}/docs/user-messages-guidelines.md`
47
+
3.**Message Style**: Follow **STRICTLY ALL 10 GUIDELINES** in `${workspaceFolder}/docs/user-messages-guidelines.md`:
48
+
- Be Clear and Concise
49
+
- Provide Specific and Actionable Information
50
+
- Avoid Technical Jargon
51
+
- Use a Polite and Non-Blaming Tone
52
+
- Avoid Negative Words and Phrases
53
+
- Place Messages Appropriately
54
+
- Use Inline Validation When Possible
55
+
- Avoid Using All-Caps and Excessive Punctuation
56
+
-**Use Humor Sparingly** - Avoid casual phrases like "Oops!", "Whoops!", or overly informal language
57
+
- Offer Alternative Solutions or Support
47
58
48
59
4.**Preserve Context**: Ensure the modified message conveys the same meaning and context as the original.
49
60
@@ -56,8 +67,10 @@ When modifying user messages, follow **as close as possible** these rules:
56
67
# After
57
68
user_message("Your session has expired. Please log in again.", _version=3)
58
69
```
70
+
59
71
6.**Replace 'Study' by 'Project'**: If the message contains the word 'Study', replace it with 'Project' to align with our terminology.
60
72
73
+
7.**Professional Tone**: Maintain a professional, helpful tone. Avoid humor, casual expressions, or overly informal language that might not be appropriate for all users or situations.
61
74
62
75
## Examples
63
76
@@ -91,4 +104,14 @@ return HttpErrorInfo(status.HTTP_404_NOT_FOUND, user_message("User not found.",
91
104
return HttpErrorInfo(status.HTTP_404_NOT_FOUND, user_message("The requested user could not be found.", _version=2))
92
105
```
93
106
94
-
Remember: The goal is to improve clarity and helpfulness for end-users while maintaining accurate versioning for tracking changes.
107
+
### Example 4: Removing Humor (Guideline 9)
108
+
109
+
```python
110
+
# Before
111
+
user_message("Oops! Something went wrong, but we've noted it down and we'll sort it out ASAP. Thanks for your patience!")
112
+
113
+
# After
114
+
user_message("Something went wrong on our end. We've been notified and will resolve this issue as soon as possible. Thank you for your patience.", _version=1)
115
+
```
116
+
117
+
Remember: The goal is to improve clarity and helpfulness for end-users while maintaining accurate versioning for tracking changes. **Always check that your updated messages comply with ALL 10 guidelines, especially avoiding humor and maintaining a professional tone.**
0 commit comments