Skip to content

Commit 9a1f18d

Browse files
committed
AI workflow:
- Improve writing style - Reduce REVIEW comments - Add a `continue-work` Just task Signed-off-by: Tzanko Matev <[email protected]>
1 parent 1016f03 commit 9a1f18d

File tree

3 files changed

+43
-3
lines changed

3 files changed

+43
-3
lines changed

agents.just

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ next-issue:
2121

2222
Note! If you try to add a commit message like 'jj new -m "blah"' or 'jj describe -m "blah"' the resulting message will not be formatted properly.
2323

24+
`cat rules/writing.md`
25+
2426
EOF
2527

2628
rm next-issue.md
@@ -34,30 +36,38 @@ review-change:
3436
- Write your review inline in the code itself by using code comments starting with '//REVIEW(author)' (or '# REVIEW(author)') to record your review.
3537
- While reviewing make sure that the rules in '/rules' folder are satisfied by the change under review.
3638
- DO NOT make any other changes in the code except adding the above-mentioned review comments.
37-
- DO NOT review code which is unrelated to the change under review
39+
- DO NOT review code which is unrelated to the change under review. You can review code not in the diff, if its functionality was indirectly changed by the diff under review.
40+
- DO NOT write positive review comments. You can write positive statements in the review summary. Use review comments ONLY to point out potential problems or improvements.
3841

3942
4. Examine the changes and update the list of issues in 'issues.md'
4043
- If the change affects a specific issue update its status
4144
- If the change partially solves an issue update its status and create new issues for the part which is not yet solved
4245
- If the change affects any non-related issue or creates new issues write that down as well
4346
- If you find any problems in the code unrelated to the change under review DO NOT write/update issues about them. We only care about how the change under review affects the overall state of the code and issues.
4447

45-
Issues file must follow the rules in '/rules/issues.md'
4648
5. Update the change description with a summary of the review using 'jj describe --stdin <<REVIEW
4749
review(codex): ...
4850
4951
...
5052
REVIEW'
53+
54+
`cat rules/writing.md`
55+
56+
`cat rules/issues.md`
5157
EOF
5258

5359
tidy-issues:
5460
#!/usr/bin/env sh
5561
codex exec --full-auto --config model_reasoning_effort=high <<EOF
5662
1. Read the file '/issues.md'.
57-
2. Check if it follows the rules in '/rules/issues.md'
63+
2. Check if it follows the rules listed below
5864
3. run 'jj new -m "issues(codex): ..."'. For example 'jj new -m "issues(codex): Removing duplicate dog-barking issue"'
5965
4. Refactor the issues database to follow the specified rules. Do the MINIMAL changes necessary to make sure that the database follows the rules, while not removing any existing information in it.
6066
5. Finally update the file '/issues-overview.md' to match the changes in 'issues.md'. It is a table of issues and statuses.
67+
68+
`cat rules/writing.md`
69+
70+
`cat rules/issues.md`
6171
EOF
6272

6373
archive-issues:
@@ -99,3 +109,17 @@ work:
99109
jj squash issues.md
100110
jj edit -r @-
101111
done
112+
113+
# This should be started if you stop at editor phase and want to continue from where you left off
114+
# Current commit should be the last review commit
115+
continue-work:
116+
#!/usr/bin/env sh
117+
while true; do
118+
EDITOR=emacsclient just agents::edit
119+
jj squash issues.md
120+
just agents::pick-next-issue
121+
[ -f next-issue.md ] || break
122+
just agents::next-issue
123+
just agents::review-change
124+
done
125+

rules/issues.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Rules for the issues.md file
2+
Issues must written in the issues.md file **MUST** follow the following rules:
23

34
* Every issue has the following attributes:
45
- issue id (e.g 'ISSUE-001')

rules/writing.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Writing style rules
2+
3+
Follow these instructions for **ALL** human-readable text that you produce:
4+
5+
* You are writing to a high-powered executive whose time is very valuable.
6+
7+
* Put the Bottom Line Up Front. Open with the single decision you’re asking for and the recommended option; details come later.
8+
9+
* Narrative > slides (when stakes are high). For complex or strategic topics, use a short narrative memo (1–6 pages)
10+
11+
* Structure ideas top-down. Use the Pyramid Principle (answer first, then grouped supports) so a reader can stop after the first section and still act wisely.
12+
13+
* Write in plain language. Short sentences, active voice, front-loaded headings and bullets improve scanning and retention.
14+
15+
* Design for scanning. Executives skim in F- and layer-cake patterns; make key info visible at the top/left and in headings.

0 commit comments

Comments
 (0)