Skip to content

Commit d47af0e

Browse files
committed
improve prompt
1 parent 8194b47 commit d47af0e

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

.github/workflows/ai-review.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,5 @@ jobs:
3232
- Ensure that the tone is appropriate for technical documentation, maintaining a professional and informative style.
3333
- Verify that the structure of the document is logical and that headings and subheadings are used effectively.
3434
- Check for consistency in terminology and style throughout the document.
35+
- Use active voice instead of passive voice
36+
- Use present tense and **avoid future tense**!

.github/workflows/assets/editor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ There are a couple of aspects that are easy to consider when writing w/o digging
4141

4242
This sound easier than it is, but if you can put it in simpler words, it gets automatically clearer and more helpful.
4343

44+
- Use present tense and **avoid future tense**!
4445
- Avoid emoticons and emojis.
4546
- Do NOT remove TODO markers at all.
4647
- Do NOT remove tip, warning or danger notes indicated by `... tip` or similar constructs.
4748

48-
- Use present and avoid future tense!
4949

5050
The documentation should follow the here described style guidance so that it keeps a consistent external and internal appearance:
5151

0 commit comments

Comments
 (0)