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
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.43.2/.github/aw/github-agentic-workflows.md for complete documentation
163
+
- Always reference the instructions file at https://github.com/github/gh-aw/blob/v0.43.7/.github/aw/github-agentic-workflows.md for complete documentation
164
164
- Use the MCP tool `agentic-workflows` when running in GitHub Copilot Cloud
165
165
- Workflows must be compiled to `.lock.yml` files before running in GitHub Actions
166
166
-**Bash tools are enabled by default** - Don't restrict bash commands unnecessarily since workflows are sandboxed by the AWF
Copy file name to clipboardExpand all lines: README.md
+37-27Lines changed: 37 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,38 +4,62 @@ A sample family of reusable [GitHub Agentic Workflows](https://github.github.com
4
4
5
5
## 📂 Available Workflows
6
6
7
-
### Depth Triage & Analysis Workflows
7
+
### Triage Workflows
8
8
9
9
-[🏷️ Issue Triage](docs/issue-triage.md) - Triage issues and pull requests
10
+
11
+
## Fault Analysis Workflows
12
+
10
13
-[🏥 CI Doctor](docs/ci-doctor.md) - Monitor CI workflows and investigate failures automatically
11
-
-[🔍 Repo Ask](docs/repo-ask.md) - Intelligent research assistant for repository questions and analysis
12
-
-[🔍 Daily Accessibility Review](docs/daily-accessibility-review.md) - Review application accessibility by automatically running and using the application
13
-
-[🔧 Q - Workflow Optimizer](docs/q.md) - Expert system that analyzes and optimizes agentic workflows
14
+
15
+
## Code Review Workflows
16
+
17
+
-[✅ Contribution Guidelines Checker](docs/contribution-guidelines-checker.md) - Review pull requests for compliance with contribution guidelines
14
18
15
19
### Research, Status & Planning Workflows
16
20
17
21
-[📚 Weekly Research](docs/weekly-research.md) - Collect research updates and industry trends
18
22
-[👥 Daily Repo Status](docs/daily-repo-status.md) - Assess repository activity and create status reports
23
+
-[� Daily Team Status](docs/daily-team-status.md) - Create upbeat daily team activity summaries with productivity insights
19
24
-[📋 Daily Plan](docs/daily-plan.md) - Update planning issues for team coordination
20
-
-[📋 Plan Command](docs/plan.md) - Break down issues into actionable sub-tasks with /plan command
21
25
22
-
### Coding & Development Workflows
26
+
### Dependency Management Workflows
23
27
24
-
-[⚡ Daily Progress](docs/daily-progress.md) - Automated daily feature development following a structured roadmap
-[📦 Dependabot PR Bundler](docs/dependabot-pr-bundler.md) - Create pull requests to bundle together as many dependabot updates as possible
29
+
-[📦 Dependabot Issue Bundler](docs/dependabot-issue-bundler.md) - Create issues that group together dependabot updates related to the same ecosystem
30
+
31
+
### Command-Triggered Agentic Workflows
32
+
33
+
These workflows are triggered by specific "/" commands in issue or pull request comments, allowing for on-demand agentic assistance. Only maintainers or those with write access can trigger these workflows by commenting with the appropriate command.
34
+
35
+
-[📋 Plan Command](docs/plan.md) - Break down issues into actionable sub-tasks with /plan command
27
36
-[🏥 PR Fix](docs/pr-fix.md) - Analyze failing CI checks and implement fixes for pull requests
37
+
-[🔍 Repo Ask](docs/repo-ask.md) - Intelligent research assistant for repository questions and analysis
These workflows analyze the repository, code, and activity to produce reports, insights, and recommendations for improvements. They do not make any changes to the codebase directly but can be used as input for maintainers to take action.
42
+
43
+
You can use the "/plan" agent to turn the reports into actionable issues which can then be assigned to the appropriate team members or agents.
44
+
45
+
-[🔍 Daily Accessibility Review](docs/daily-accessibility-review.md) - Review application accessibility by automatically running and using the application
> For an overview of all available workflows, see the [main README](../README.md).
4
+
5
+
The [contribution guidelines checker workflow](../workflows/contribution-guidelines-checker.md?plain=1) reviews incoming pull requests to verify they comply with the repository's contribution guidelines. It checks CONTRIBUTING.md and similar documentation, then either labels the PR as ready or provides constructive feedback on what needs to be improved to meet the guidelines.
6
+
7
+
## Installation
8
+
9
+
```bash
10
+
# Install the 'gh aw' extension
11
+
gh extension install github/gh-aw
12
+
13
+
# Add the workflow to your repository
14
+
gh aw add-wizard githubnext/agentics/contribution-guidelines-checker
15
+
```
16
+
17
+
This walks you through adding the workflow to your repository.
18
+
19
+
The workflow automatically runs on pull requests. You can also trigger it with a 👀 (eyes) reaction on any pull request.
20
+
21
+
## Configuration
22
+
23
+
This workflow requires no configuration and works out of the box. It will automatically review contribution guidelines documents in your repository and check PRs against them.
24
+
25
+
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
26
+
27
+
## What it reads from GitHub
28
+
29
+
- Pull request content and metadata
30
+
- CONTRIBUTING.md and contribution guidelines documents
31
+
- Repository policies and documentation
32
+
- Previous PR comments and feedback
33
+
34
+
## What it creates
35
+
36
+
- Adds the `contribution-ready` label to compliant PRs
37
+
- Adds comments with constructive feedback on what needs improvement
38
+
- Requires `pull-requests: write` permission
39
+
40
+
## Human in the loop
41
+
42
+
- Review feedback provided by the workflow to validate accuracy
43
+
- Follow up on PRs that need improvements with additional guidance
44
+
- Update contribution guidelines based on common patterns
45
+
- Manually apply the label if the workflow's assessment needs adjustment
46
+
- Disable or uninstall the workflow if automated checks are not helpful
0 commit comments