Skip to content

Commit ac4f639

Browse files
committed
add repo assist
1 parent a063232 commit ac4f639

2 files changed

Lines changed: 511 additions & 0 deletions

File tree

β€Ždocs/repo-assist.mdβ€Ž

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
````markdown
2+
# πŸ€– Repo Assist
3+
4+
> For an overview of all available workflows, see the [main README](../README.md).
5+
6+
The [Repo Assist workflow](../workflows/repo-assist.md?plain=1) is a friendly repository assistant that runs daily to support contributors and maintainers. It triages issues, comments helpfully, fixes bugs via pull requests, proposes improvements, maintains its own PRs, nudges stale PRs, manages labels, prepares releases, welcomes new contributors, and maintains a monthly activity summary for maintainer visibility.
7+
8+
## Installation
9+
10+
```bash
11+
# Install the 'gh aw' extension
12+
gh extension install github/gh-aw
13+
14+
# Add the workflow to your repository
15+
gh aw add-wizard githubnext/agentics/repo-assist
16+
```
17+
18+
This walks you through adding the workflow to your repository.
19+
20+
You can start a run of this workflow immediately by running:
21+
22+
```bash
23+
gh aw run repo-assist
24+
```
25+
26+
## How It Works
27+
28+
````mermaid
29+
graph LR
30+
A[Read Memory] --> B[Triage Issues]
31+
B --> C[Fix Bugs via PR]
32+
C --> D[Propose Improvements]
33+
D --> E[Update Own PRs]
34+
E --> F[Nudge Stale PRs]
35+
F --> G[Manage Labels]
36+
G --> H[Prepare Releases]
37+
H --> I[Welcome Contributors]
38+
I --> J[Update Activity Summary]
39+
J --> K[Save Memory]
40+
````
41+
42+
The workflow operates through ten coordinated tasks each run:
43+
44+
### Task 1: Triage and Comment on Open Issues
45+
46+
Repo Assist reviews open issues and comments **only when it has something genuinely valuable to add**. It identifies issue types (bug reports, feature requests, questions) and provides helpful responses while avoiding noise.
47+
48+
### Task 2: Fix Issues via Pull Requests
49+
50+
When it finds a fixable bug, Repo Assist implements a minimal, surgical fix, runs build and tests, and creates a draft PR. All PRs include a Test Status section showing build/test results.
51+
52+
### Task 3: Study the Codebase and Propose Improvements
53+
54+
Repo Assist identifies improvement opportunities like documentation gaps, test coverage, and code clarity. It proposes only clearly beneficial, low-risk changes.
55+
56+
### Task 4: Update Dependencies and Engineering
57+
58+
Periodically (at most weekly), Repo Assist checks for dependency updates and engineering improvements, creating PRs for beneficial changes.
59+
60+
### Task 5: Maintain Repo Assist Pull Requests
61+
62+
Keeps its own PRs healthy by fixing CI failures and resolving merge conflicts. Uses `push_to_pull_request_branch` to update PR branches directly.
63+
64+
### Task 6: Stale PR Nudges
65+
66+
Politely nudges PR authors when their PRs have been waiting 14+ days for response. Maximum 3 nudges per run, never nags the same PR twice.
67+
68+
### Task 7: Manage Labels
69+
70+
Applies appropriate labels (`bug`, `enhancement`, `help wanted`, `good first issue`) to unlabeled issues and PRs based on content analysis. Conservative and confident.
71+
72+
### Task 8: Release Preparation
73+
74+
Weekly, checks for unreleased changes and proposes release PRs with updated changelogs. Follows SemVer β€” never proposes major bumps without approval.
75+
76+
### Task 9: Welcome New Contributors
77+
78+
Greets first-time contributors with a warm welcome message, pointing them to README and CONTRIBUTING docs. Maximum 3 welcomes per run.
79+
80+
### Task 10: Monthly Activity Summary
81+
82+
Every run, Repo Assist updates a rolling monthly activity issue that gives maintainers a single place to see all activity and suggested actions.
83+
84+
## Configuration
85+
86+
This workflow requires no configuration and works out of the box. It uses repo-memory to track work across runs and avoid duplicate actions.
87+
88+
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
89+
90+
## What it reads from GitHub
91+
92+
- Open issues and their comments
93+
- Open and merged pull requests
94+
- Repository contents and file structure
95+
- Labels and issue metadata
96+
- Its own memory from previous runs (stored in a repo-memory branch)
97+
98+
## What it creates
99+
100+
- Comments on issues with helpful responses (with AI disclosure)
101+
- Draft pull requests with bug fixes, improvements, or release preparation
102+
- Pushes updates to its own PRs to fix CI failures or conflicts
103+
- Labels on issues and PRs for organization
104+
- Welcome comments for new contributors
105+
- Issues to track improvement ideas or monthly activity summaries
106+
- Requires `issues: write`, `pull-requests: write`, and `contents: write` permissions
107+
108+
## What web searches it performs
109+
110+
- May search for documentation or solutions related to issues being addressed
111+
112+
## Human in the loop
113+
114+
- Review all draft PRs created by Repo Assist before merging
115+
- Validate that fixes actually resolve the intended issues
116+
- Approve or reject proposed improvements based on project goals
117+
- Use the monthly activity issue to track Repo Assist's work
118+
- Comment `@repo-assist` on issues if you want follow-up input
119+
- Close or hide comments that are not helpful
120+
- Disable or uninstall the workflow if it creates too much noise
121+
122+
## Guidelines Repo Assist Follows
123+
124+
- **Quality over quantity**: Silence is preferable to noise
125+
- **No breaking changes**: Never changes public APIs without explicit approval
126+
- **No new dependencies**: Discusses in an issue first
127+
- **Small, focused PRs**: One concern per PR
128+
- **AI transparency**: Every output includes robot emoji disclosure
129+
- **Anti-spam**: Never posts repeated or follow-up comments to itself
130+
- **Build and test verification**: Never creates PRs with failing builds
131+
132+
## Example Monthly Activity Issue
133+
134+
```markdown
135+
πŸ€– *Repo Assist here β€” I'm an automated AI assistant for this repository.*
136+
137+
## Activity for February 2026
138+
139+
### 2026-02-21
140+
- πŸ’¬ Commented on #42: Provided reproduction steps for auth bug
141+
- πŸ”§ Created PR #45: Fix null check in config parser
142+
143+
### 2026-02-20
144+
- πŸ“ Created issue #44: Suggest adding JSDoc to exported functions
145+
146+
## Suggested Actions for Maintainer
147+
148+
- πŸ”€ **Merge PR** #45: Simple null check fix, tests pass β€” [Review](link)
149+
- βœ… **Close issue** #38: Duplicate of #42 β€” [View](link)
150+
```
151+
````

0 commit comments

Comments
Β (0)