Skip to content

Commit 656525c

Browse files
fix: address code review issues and rename to agent-ready
Code review fixes: - Replace CODEOWNERS placeholder with @robotlearning123 - Fix AGENTS.md placeholder text and add code block language - Remove brackets from ESLint/Prettier in CONTRIBUTING.md - Update factory_compat.yaml: 9→10 pillars, add multi-language build manifest - Add language tags to README.md fenced code blocks - Fix file-exists.ts: use null check for empty file handling - Fix github-workflow.ts: correct branch matching for all-branches triggers - Fix markdown.ts: dynamic padding for badge alignment - Harden regex.ts ReDoS detection with per-group stack tracking - Fix templates/AGENTS.md code block language - Fix test fixture README.md: npm run dev → npm run test - Fix subagent.ts: track natural completion vs hitting turn limit - Fix ollama.ts: buffer partial JSON lines across stream chunks - Fix sandbox/index.ts: add cwd validation to runDirect, prevent double-resolve Rename agent-readiness → agent-ready: - Update package.json name and repository URLs - Update all documentation references - Update source code comments and config files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c37d611 commit 656525c

File tree

21 files changed

+192
-111
lines changed

21 files changed

+192
-111
lines changed

agent-readiness/.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "agent-readiness",
2+
"name": "agent-ready",
33
"image": "mcr.microsoft.com/devcontainers/typescript-node:20",
44
"features": {
55
"ghcr.io/devcontainers/features/git:1": {}

agent-readiness/.github/CODEOWNERS

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Code ownership for agent-readiness
1+
# Code ownership for agent-ready
22
# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
33

44
# Default owners for everything in the repo
5-
* @{{GITHUB_USERNAME}}
5+
* @robotlearning123
66

77
# Documentation
8-
/docs/ @{{GITHUB_USERNAME}}
9-
*.md @{{GITHUB_USERNAME}}
8+
/docs/ @robotlearning123
9+
*.md @robotlearning123
1010

1111
# CI/CD configuration
12-
/.github/ @{{GITHUB_USERNAME}}
12+
/.github/ @robotlearning123
1313

1414
# Source code
15-
/src/ @{{GITHUB_USERNAME}}
15+
/src/ @robotlearning123
1616

1717
# Tests
18-
/test/ @{{GITHUB_USERNAME}}
18+
/test/ @robotlearning123

agent-readiness/AGENTS.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides instructions for AI agents working with this codebase.
44

55
## Project Overview
66

7-
agent-readiness is a [brief description of your project].
7+
agent-ready is a CLI tool that scans repositories for AI agent readiness, evaluating maturity across 10 pillars with 5 levels (L1-L5) using the Factory Agent Readiness model.
88

99
## Getting Started
1010

@@ -39,10 +39,13 @@ npm run build
3939

4040
## Codebase Structure
4141

42-
```
42+
```text
4343
src/
44-
├── index.ts # Entry point
45-
├── [describe key directories]
44+
├── index.ts # CLI entry point
45+
├── checks/ # Check implementations (file_exists, github_workflow, etc.)
46+
├── engine/ # Core scanning engine
47+
├── output/ # Output formatters (JSON, Markdown)
48+
└── utils/ # Shared utilities (regex, file cache, path validation)
4649
```
4750

4851
## Key Conventions

agent-readiness/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to agent-readiness
1+
# Contributing to agent-ready
22

33
Thank you for your interest in contributing! This document provides guidelines and steps for contributing.
44

@@ -36,8 +36,8 @@ Please be respectful and constructive in all interactions.
3636

3737
```bash
3838
# Clone your fork
39-
git clone https://github.com/YOUR_USERNAME/agent-readiness.git
40-
cd agent-readiness
39+
git clone https://github.com/YOUR_USERNAME/agent-ready.git
40+
cd agent-ready
4141

4242
# Install dependencies
4343
npm install
@@ -51,7 +51,7 @@ npm run dev
5151

5252
## Code Style
5353

54-
- We use [ESLint/Prettier] for code formatting
54+
- We use ESLint and Prettier for code formatting
5555
- Run `npm run lint` before committing
5656
- Follow existing patterns in the codebase
5757

agent-readiness/FACTORY_COMPARISON.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Factory Agent Readiness Comparison
22

3-
This document compares our agent-readiness implementation with [Factory's official Agent Readiness Model](https://docs.factory.ai/web/agent-readiness/overview).
3+
This document compares our agent-ready implementation with [Factory's official Agent Readiness Model](https://docs.factory.ai/web/agent-readiness/overview).
44

55
## Executive Summary
66

agent-readiness/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# agent-readiness
1+
# agent-ready
22

3-
Factory-compatible repo maturity scanner CLI tool that evaluates repositories against the **9 Pillars / 5 Levels** model and outputs actionable readiness reports for AI agents.
3+
Factory-compatible repo maturity scanner CLI tool that evaluates repositories against the **10 Pillars / 5 Levels** model and outputs actionable readiness reports for AI agents.
44

55
## Features
66

7-
- **9 Pillars Assessment**: Documentation, Code Style, Build, Testing, Security, Observability, Environment, CI/CD, Monorepo
7+
- **10 Pillars Assessment**: Documentation, Code Style, Build, Testing, Security, Observability, Environment, CI/CD, Monorepo, Task Discovery
88
- **5 Maturity Levels**: L1 (Minimal) → L5 (Optimal)
99
- **80% Gating Rule**: Levels achieved when ≥80% of checks pass AND all required checks pass
1010
- **Extensible Profiles**: YAML-based check definitions
@@ -63,7 +63,7 @@ npm run dev -- init --dry-run
6363

6464
### Terminal Output
6565

66-
```
66+
```text
6767
Agent Readiness Report
6868
──────────────────────────────────────────────────
6969
Repository: owner/repo
@@ -107,7 +107,7 @@ Action Items
107107
}
108108
```
109109

110-
## The 9 Pillars / 5 Levels Model
110+
## The 10 Pillars / 5 Levels Model
111111

112112
### Pillars
113113

@@ -122,6 +122,7 @@ Action Items
122122
| **Environment** | .env.example templates |
123123
| **CI/CD** | GitHub workflows, triggers, actions |
124124
| **Monorepo** | Workspace configuration |
125+
| **Task Discovery** | Issue templates, PR templates |
125126

126127
### Levels
127128

@@ -199,8 +200,8 @@ npm run build
199200

200201
## Project Structure
201202

202-
```
203-
agent-readiness/
203+
```text
204+
agent-ready/
204205
├── src/
205206
│ ├── index.ts # CLI entry
206207
│ ├── types.ts # Type definitions

agent-readiness/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ services:
2121
# environment:
2222
# POSTGRES_USER: dev
2323
# POSTGRES_PASSWORD: dev_password
24-
# POSTGRES_DB: agent-readiness
24+
# POSTGRES_DB: agent-ready
2525
# ports:
2626
# - "5432:5432"
2727
# volumes:

agent-readiness/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

agent-readiness/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "agent-readiness",
2+
"name": "agent-ready",
33
"version": "0.1.0",
44
"description": "Factory-compatible repo maturity scanner for AI agent readiness",
55
"type": "module",
@@ -34,11 +34,11 @@
3434
},
3535
"repository": {
3636
"type": "git",
37-
"url": "git+https://github.com/robotlearning123/agent-readiness.git"
37+
"url": "git+https://github.com/robotlearning123/agent-ready.git"
3838
},
39-
"homepage": "https://github.com/robotlearning123/agent-readiness#readme",
39+
"homepage": "https://github.com/robotlearning123/agent-ready#readme",
4040
"bugs": {
41-
"url": "https://github.com/robotlearning123/agent-readiness/issues"
41+
"url": "https://github.com/robotlearning123/agent-ready/issues"
4242
},
4343
"keywords": [
4444
"ai",

agent-readiness/profiles/factory_compat.yaml

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Factory-Compatible Agent Readiness Profile
2-
# Evaluates repositories against the 9 Pillars / 5 Levels model
2+
# Evaluates repositories against the 10 Pillars / 5 Levels model
33

44
name: factory_compat
55
version: "1.0.0"
66
description: >
77
Default profile for evaluating repository maturity for AI agent readiness.
8-
Based on the 9 Pillars model with 5 maturity levels (L1-L5).
8+
Based on the 10 Pillars model with 5 maturity levels (L1-L5).
99
1010
checks:
1111
# =============================================================================
@@ -175,14 +175,42 @@ checks:
175175
# PILLAR: Build System (build)
176176
# =============================================================================
177177

178-
- id: build.package_json
179-
name: Package manifest
180-
description: package.json exists with build scripts
181-
type: file_exists
178+
- id: build.manifest
179+
name: Build manifest
180+
description: Repository has a primary build manifest
181+
type: any_of
182182
pillar: build
183183
level: L1
184184
required: true
185-
path: package.json
185+
checks:
186+
- id: build.package_json
187+
name: package.json
188+
type: file_exists
189+
pillar: build
190+
level: L1
191+
required: false
192+
path: package.json
193+
- id: build.pyproject
194+
name: pyproject.toml
195+
type: file_exists
196+
pillar: build
197+
level: L1
198+
required: false
199+
path: pyproject.toml
200+
- id: build.cargo_toml
201+
name: Cargo.toml
202+
type: file_exists
203+
pillar: build
204+
level: L1
205+
required: false
206+
path: Cargo.toml
207+
- id: build.makefile
208+
name: Makefile
209+
type: file_exists
210+
pillar: build
211+
level: L1
212+
required: false
213+
path: Makefile
186214

187215
- id: build.scripts
188216
name: Build scripts defined

0 commit comments

Comments
 (0)