Skip to content

Commit ca361a4

Browse files
committed
fix: Improve report metadata display with clean table format
- Replace verbose header with concise metadata table - Show git remote URL instead of full filesystem path - Include all key info in single row: repo, branch, commit, score, level, date - Update example self-assessment report with new format - Score improved to 80.0/100 (Gold) after recent changes
1 parent 292ffa8 commit ca361a4

2 files changed

Lines changed: 21 additions & 75 deletions

File tree

examples/self-assessment/report-20251121.md

Lines changed: 15 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# 🤖 AgentReady Assessment Report
22

3-
**Repository**: agentready
4-
**Path**: `/Users/jeder/repos/sk/agentready`
5-
**Branch**: 001-agentready-scorer
6-
**Commit**: adfc4c82
7-
**Date**: 2025-11-21 02:11:05
3+
| Repository | Branch | Commit | Score | Level | Date |
4+
|------------|--------|--------|-------|-------|------|
5+
| **git@github.com:ambient-code/agentready.git** | main | `292ffa8d` | **80.0/100** | **Gold** | 2025-11-21 04:10 |
86

97
---
108

119
## 📊 Summary
1210

1311
| Metric | Value |
1412
|--------|-------|
15-
| **Overall Score** | **75.4/100** |
13+
| **Overall Score** | **80.0/100** |
1614
| **Certification Level** | **Gold** |
1715
| **Attributes Assessed** | 10/25 |
1816
| **Attributes Skipped** | 15 |
19-
| **Assessment Duration** | 0.2s |
17+
| **Assessment Duration** | 0.3s |
2018

2119
### Languages Detected
2220

23-
- **Markdown**: 36 files
24-
- **Python**: 31 files
21+
- **Markdown**: 75 files
22+
- **Python**: 36 files
23+
- **YAML**: 9 files
2524
- **Shell**: 5 files
25+
- **JSON**: 5 files
2626

2727
### Repository Stats
2828

29-
- **Total Files**: 79
30-
- **Total Lines**: 13,852
29+
- **Total Files**: 157
30+
- **Total Lines**: 69,295
3131

3232
## 🎖️ Certification Ladder
3333

@@ -172,70 +172,15 @@ npm install --save-dev @commitlint/cli @commitlint/config-conventional husky
172172
| Attribute | Tier | Status | Score |
173173
|-----------|------|--------|-------|
174174
| Test Coverage Requirements | T2 | ✅ pass | 100 |
175-
| Pre-commit Hooks & CI/CD Linting | T2 | ❌ fail | 0 |
176-
177-
#### ❌ Pre-commit Hooks & CI/CD Linting
178-
179-
**Measured**: not configured (Threshold: configured)
180-
181-
**Evidence**:
182-
- .pre-commit-config.yaml not found
183-
184-
<details><summary><strong>📝 Remediation Steps</strong></summary>
185-
186-
187-
Configure pre-commit hooks for automated code quality checks
188-
189-
1. Install pre-commit framework
190-
2. Create .pre-commit-config.yaml
191-
3. Add hooks for linting and formatting
192-
4. Install hooks: pre-commit install
193-
5. Run on all files: pre-commit run --all-files
194-
195-
**Commands**:
196-
197-
```bash
198-
pip install pre-commit
199-
pre-commit install
200-
pre-commit run --all-files
201-
```
202-
203-
**Examples**:
204-
205-
```
206-
# .pre-commit-config.yaml
207-
repos:
208-
- repo: https://github.com/pre-commit/pre-commit-hooks
209-
rev: v4.4.0
210-
hooks:
211-
- id: trailing-whitespace
212-
- id: end-of-file-fixer
213-
- id: check-yaml
214-
- id: check-added-large-files
215-
216-
- repo: https://github.com/psf/black
217-
rev: 23.3.0
218-
hooks:
219-
- id: black
220-
221-
- repo: https://github.com/pycqa/isort
222-
rev: 5.12.0
223-
hooks:
224-
- id: isort
225-
226-
```
227-
228-
</details>
175+
| Pre-commit Hooks & CI/CD Linting | T2 | ✅ pass | 100 |
229176

230177
## 🎯 Next Steps
231178

232179
**Priority Improvements** (highest impact first):
233180

234181
1. **Lock Files for Reproducibility** (Tier 1) - +10.0 points potential
235182
- Add lock file for dependency reproducibility
236-
2. **Pre-commit Hooks & CI/CD Linting** (Tier 2) - +3.0 points potential
237-
- Configure pre-commit hooks for automated code quality checks
238-
3. **Conventional Commit Messages** (Tier 2) - +3.0 points potential
183+
2. **Conventional Commit Messages** (Tier 2) - +3.0 points potential
239184
- Configure conventional commits with commitlint
240185

241186
---
@@ -244,7 +189,7 @@ repos:
244189

245190
- **Tool Version**: AgentReady v1.0.0
246191
- **Research Report**: Bundled version
247-
- **Repository Snapshot**: adfc4c823a7b25d5b1404c9b994461e290257dce
248-
- **Assessment Duration**: 0.2s
192+
- **Repository Snapshot**: 292ffa8d5541b2edf545fc492c9367d15675f932
193+
- **Assessment Duration**: 0.3s
249194

250195
🤖 Generated with [Claude Code](https://claude.com/claude-code)

src/agentready/reporters/markdown.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,14 @@ def generate(self, assessment: Assessment, output_path: Path) -> Path:
6363

6464
def _generate_header(self, assessment: Assessment) -> str:
6565
"""Generate report header with repository info."""
66+
# Get git remote URL if available, otherwise use repo name
67+
repo_display = assessment.repository.url if assessment.repository.url else assessment.repository.name
68+
6669
return f"""# 🤖 AgentReady Assessment Report
6770
68-
**Repository**: {assessment.repository.name}
69-
**Path**: `{assessment.repository.path}`
70-
**Branch**: {assessment.repository.branch}
71-
**Commit**: {assessment.repository.commit_hash[:8]}
72-
**Date**: {assessment.timestamp.strftime('%Y-%m-%d %H:%M:%S')}
71+
| Repository | Branch | Commit | Score | Level | Date |
72+
|------------|--------|--------|-------|-------|------|
73+
| **{repo_display}** | {assessment.repository.branch} | `{assessment.repository.commit_hash[:8]}` | **{assessment.overall_score:.1f}/100** | **{assessment.certification_level}** | {assessment.timestamp.strftime('%Y-%m-%d %H:%M')} |
7374
7475
---"""
7576

0 commit comments

Comments
 (0)