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: docs/repository-quality-improver.md
+15-16Lines changed: 15 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
> For an overview of all available workflows, see the [main README](../README.md).
4
4
5
-
The [Repository Quality Improver workflow](../workflows/repository-quality-improver.md?plain=1) analyzes your repository from a different quality angle every day, producing a discussion with findings and actionable improvement tasks.
5
+
The [Repository Quality Improver workflow](../workflows/repository-quality-improver.md?plain=1) analyzes your repository from a different quality angle every weekday, producing an issue with findings and actionable improvement tasks.
6
6
7
7
## Installation
8
8
@@ -18,15 +18,15 @@ Then compile:
18
18
gh aw compile
19
19
```
20
20
21
-
> **Note**: This workflow posts results as GitHub Discussions. Make sure Discussions are enabled in your repository settings, and update the `category` field in the workflow to match an existing discussion category in your repo.
21
+
> **Note**: This workflow creates GitHub Issues with the `quality`and `automated-analysis` labels.
22
22
23
23
## What It Does
24
24
25
25
The Repository Quality Improver runs on weekdays and:
26
26
27
27
1.**Selects a Focus Area** β Picks a different quality dimension each run, using a rotating strategy to ensure broad, diverse coverage over time
28
28
2.**Analyzes the Repository** β Examines source code, configuration, tests, and documentation from the chosen angle
29
-
3.**Produces a Discussion** β Posts a structured report with findings, metrics, and 3β5 actionable improvement tasks
29
+
3.**Creates an Issue** β Posts a structured report with findings, metrics, and 3β5 actionable improvement tasks
30
30
4.**Tracks History** β Remembers previous focus areas (using cache memory) to avoid repetition and maximize coverage
31
31
32
32
## How It Works
@@ -41,7 +41,7 @@ graph LR
41
41
D --> G[Analyze Repository]
42
42
E --> G
43
43
F --> G
44
-
G --> H[Generate Discussion Report]
44
+
G --> H[Create Issue Report]
45
45
H --> I[Update Cache Memory]
46
46
````
47
47
@@ -55,16 +55,16 @@ The workflow follows a deliberate diversity strategy across runs:
55
55
56
56
Over ten runs, the agent will typically explore 6β7+ unique quality dimensions.
57
57
58
-
### Output: GitHub Discussions
58
+
### Output: GitHub Issues
59
59
60
-
Each run produces one discussion containing:
60
+
Each run produces one issue containing:
61
61
62
62
-**Executive Summary** β 2β3 paragraphs of key findings
63
63
-**Full Analysis** β Detailed metrics, strengths, and areas for improvement (collapsed)
64
64
-**Improvement Tasks** β 3β5 concrete, prioritized tasks with file-level specificity
65
65
-**Historical Context** β Table of previous focus areas for reference
66
66
67
-
You can use the `/plan` command on the discussion to automatically break the tasks into trackable GitHub issues.
67
+
You can comment on the issue to request follow-up actions or add it to a project board for tracking.
68
68
69
69
## Example Reports
70
70
@@ -78,10 +78,10 @@ The workflow uses these default settings:
78
78
79
79
| Setting | Default | Description |
80
80
|---------|---------|-------------|
81
-
| Schedule |Weekdays at 1 PM UTC| When to run the analysis |
82
-
|Discussion category|`General`| Category for posted discussions|
83
-
| Max discussions per run | 1 | Prevents duplicate reports |
84
-
|Discussion expiry | 2 days | Older discussions are closed when a new one is posted |
81
+
| Schedule |Daily on weekdays| When to run the analysis |
82
+
|Issue labels|`quality`, `automated-analysis`| Labels applied to created issues|
83
+
| Max issues per run | 1 | Prevents duplicate reports |
84
+
|Issue expiry | 2 days | Older issues are closed when a new one is posted |
85
85
| Timeout | 20 minutes | Per-run time limit |
86
86
87
87
## Customization
@@ -91,24 +91,23 @@ gh aw edit repository-quality-improver
91
91
```
92
92
93
93
Common customizations:
94
-
-**Change discussion category** β Set the `category` field in `safe-outputs.create-discussion` to a category that exists in your repo's Discussions settings
94
+
-**Change issue labels** β Set the `labels` field in `safe-outputs.create-issue` to labels that exist in your repository
95
95
-**Adjust the schedule** β Change the cron to run less frequently if your codebase changes slowly
96
96
-**Add custom standard areas** β Extend the standard categories list with areas relevant to your project
97
97
98
98
## Tips for Success
99
99
100
-
1.**Enable GitHub Discussions** β The workflow requires Discussions to be turned on in your repository settings
101
-
2.**Use `/plan` on reports** β Pair this workflow with the [Plan Command](plan.md) to automatically turn discussion tasks into trackable issues
100
+
1.**Review open issues** β Check the labeled issues regularly to pick up quick wins
101
+
2.**Add issues to a project board** β Track improvement tasks using GitHub Projects for visibility
102
102
3.**Let the diversity algorithm work** β Avoid overriding the focus area too frequently; the rotating strategy ensures broad coverage over time
103
-
4.**Review weekly** β Check the weekly discussion thread to pick up any quick wins
103
+
4.**Review weekly** β Check recent issues to pick up any quick wins
104
104
105
105
## Source
106
106
107
107
This workflow is adapted from [Peli's Agent Factory](https://github.github.io/gh-aw/blog/2026-01-13-meet-the-workflows-continuous-improvement/), where it achieved a 62% merge rate (25 merged PRs out of 40 proposed) via a causal discussion β issue β PR chain.
108
108
109
109
## Related Workflows
110
110
111
-
-[Plan Command](plan.md) β Turn discussion tasks into actionable sub-issues with `/plan`
112
111
-[Daily File Diet](daily-file-diet.md) β Targeted refactoring for oversized files
Copy file name to clipboardExpand all lines: workflows/repository-quality-improver.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,7 @@
2
2
name: Repository Quality Improver
3
3
description: Daily analysis of repository quality focusing on a different software development lifecycle area each run
4
4
on:
5
-
schedule:
6
-
- cron: "0 13 * * *"# Daily at 1 PM UTC
5
+
schedule: daily on weekdays
7
6
workflow_dispatch:
8
7
permissions:
9
8
contents: read
@@ -20,11 +19,10 @@ tools:
20
19
toolsets:
21
20
- default
22
21
safe-outputs:
23
-
create-discussion:
22
+
create-issue:
24
23
expires: 2d
25
-
category: "General"
24
+
labels: [quality, automated-analysis]
26
25
max: 1
27
-
close-older-discussions: true
28
26
timeout-minutes: 20
29
27
strict: true
30
28
@@ -36,7 +34,7 @@ You are the Repository Quality Improvement Agent β an expert system that perio
36
34
37
35
## Mission
38
36
39
-
Daily or on-demand, select a focus area for repository improvement, conduct analysis, and produce a single discussion with actionable tasks. Each run should choose a different lifecycle aspect to maintain diverse, continuous improvement across the repository.
37
+
Daily or on-demand, select a focus area for repository improvement, conduct analysis, and produce a single issue with actionable tasks. Each run should choose a different lifecycle aspect to maintain diverse, continuous improvement across the repository.
Write a comprehensive report as a GitHub discussion with the following structure:
277
+
Write a comprehensive report as a GitHub issue with the following structure:
280
278
281
-
**Report Formatting**: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. The discussion title serves as h1, so start section headers at h3.
279
+
**Report Formatting**: Use h3 (###) or lower for all headers in the report to maintain proper document hierarchy. The issue title serves as h1, so start section headers at h3.
0 commit comments