Skip to content

Commit 36b1dba

Browse files
docs: address PR review comments on AGENTS.md
Fix workflow count (6→8), correct writing-inputs description, wrap bare commands in fenced code blocks, remove non-existent .github/instructions/ reference, and update .github/ tree to reflect current repo state (dependabot, CODEOWNERS, ISSUE_TEMPLATE).
1 parent d17e8fc commit 36b1dba

1 file changed

Lines changed: 28 additions & 16 deletions

File tree

AGENTS.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ docs/
2929
├── GENERATED_DOCS_REFERENCE.md # Full aidlc-docs/ directory reference
3030
└── writing-inputs/ # Guides and examples for vision/tech-env documents
3131
.github/
32-
├── workflows/ # CI/CD pipelines (6 workflows)
32+
├── workflows/ # CI/CD pipelines (8 workflows)
33+
├── dependabot.yml # Dependabot dependency update configuration
34+
├── CODEOWNERS # Code ownership rules for PR reviews
35+
├── ISSUE_TEMPLATE/ # Issue templates
3336
├── pull_request_template.md # PR template with contributor statement
3437
└── labeler.yml # Auto-label rules (path → label mapping)
3538
.claude/ # Claude Code project settings
@@ -53,7 +56,7 @@ docs/
5356

5457
- CI/CD, workflows, or releases → `ADMINISTRATIVE_GUIDE.md`, `DEVELOPERS_GUIDE.md`
5558
- aidlc-rules content → `WORKING-WITH-AIDLC.md`, `GENERATED_DOCS_REFERENCE.md`
56-
- Installation or setup instructions`docs/writing-inputs/`
59+
- Vision or technical environment documents`docs/writing-inputs/`
5760

5861
## Setup commands
5962

@@ -142,29 +145,38 @@ For full remediation and suppression details, see
142145
Short guidance for agents: prefer the repository uv wrapper and npx-based tools. Read docs/DEVELOPERS_GUIDE.md and docs/ADMINISTRATIVE_GUIDE.md before running any commands.
143146

144147
Tests (uv):
148+
149+
```bash
145150
uv run pytest
146151
uv run pytest --cov --cov-report=term-missing
152+
```
147153

148154
Markdown lint (npx):
155+
156+
```bash
149157
npx markdownlint-cli2 "**/*.md"
150158
npx markdownlint-cli2 --fix "**/*.md"
159+
```
151160

152-
Dockerized security scans (recommended for local, cross-platform)
153-
- Grype:
154-
docker run --rm -v "$PWD:/workspace" anchore/grype:latest grype dir:/workspace -o sarif=grype.sarif
155-
- Gitleaks:
156-
docker run --rm -v "$PWD:/repo" zricethezav/gitleaks:latest detect --source /repo --report-format sarif --report-path gitleaks.sarif
157-
- Semgrep:
158-
docker run --rm -v "$PWD:/src" returntocorp/semgrep semgrep --config=r/all --sarif /src > semgrep.sarif
159-
- Checkov:
160-
docker run --rm -v "$PWD:/src" bridgecrew/checkov --directory /src --output-file-path checkov.sarif --output sarif
161-
- Bandit:
162-
docker run --rm -v "$PWD:/src" python:3.12-slim bash -c "pip install -q bandit && bandit -r /src -f sarif -o /src/bandit.sarif"
163-
- ClamAV:
164-
docker run --rm -v "$PWD:/data" mkodockx/docker-clamav clamscan -r /data --log=/data/clamdscan.txt
161+
Dockerized security scans (recommended for local, cross-platform):
162+
163+
```bash
164+
# Grype
165+
docker run --rm -v "$PWD:/workspace" anchore/grype:latest grype dir:/workspace -o sarif=grype.sarif
166+
# Gitleaks
167+
docker run --rm -v "$PWD:/repo" zricethezav/gitleaks:latest detect --source /repo --report-format sarif --report-path gitleaks.sarif
168+
# Semgrep
169+
docker run --rm -v "$PWD:/src" returntocorp/semgrep semgrep --config=r/all --sarif /src > semgrep.sarif
170+
# Checkov
171+
docker run --rm -v "$PWD:/src" bridgecrew/checkov --directory /src --output-file-path checkov.sarif --output sarif
172+
# Bandit
173+
docker run --rm -v "$PWD:/src" python:3.12-slim bash -c "pip install -q bandit && bandit -r /src -f sarif -o /src/bandit.sarif"
174+
# ClamAV
175+
docker run --rm -v "$PWD:/data" mkodockx/docker-clamav clamscan -r /data --log=/data/clamdscan.txt
176+
```
165177

166178
Notes:
179+
167180
- These commands write SARIF/text artifacts to the project root so CI/agents can consume them.
168181
- CI already runs scanners; use these for local verification when Docker is available.
169182
- If Docker is unavailable, use the platform-specific installs documented in docs/DEVELOPERS_GUIDE.md.
170-
- Keep Copilot-specific instructions in .github/instructions/ to avoid duplication.

0 commit comments

Comments
 (0)