[Draft] Issue #246: [DISCUSSION] Reconsider src/ directory requirement?

[github-actions]

🤖 Auto-generated Draft PR

This draft PR was automatically created from issue #246.

Original Issue: #246

Analysis Summary:
The issue is well-defined with concrete examples from major Python projects. Relaxing src/ requirement to accept project-named directories aligns with common practice and AgentReady's goal of recognizing standard patterns.

---

The standard_layout detector for Python requires that all code be in a directory named src/. However, in practice, it seems like a common practice in Python to name the source directory after the project itself; either the name of the root directory or some variation of it. For example:

• https://github.com/pandas-dev/pandas/tree/main/pandas
• https://github.com/numpy/numpy/tree/main/numpy
• https://github.com/vllm-project/vllm/tree/main/vllm
• https://github.com/scikit-learn/scikit-learn/tree/main/sklearn
• https://github.com/apache/iceberg-python/tree/main/pyiceberg

Of course, src/ is also seen sometimes, e.g.:

• https://github.com/huggingface/transformers/tree/main/src/transformers
• https://github.com/llamastack/llama-stack/tree/main/src/llama_stack

So I would say that both of these patterns are relatively "standard" layouts, so I would expect models trained on common practice to be comfortable with both.

---

This PR was automatically created by the @agentready-dev workflow.
View activity log

[github-actions]

AgentReady Code Review - PR #255

Review Summary

PR Type: Discussion Draft - Process Placeholder
Attribute Focus: standard_layout (Tier 1 Essential, 10% weight)
Overall Assessment: ⚠️ Blocked - No Implementation Yet

AgentReady Attribute Analysis

issue_pr_templates (Tier 3, 1.5% weight)

• Status: PASS
• Evidence: PR demonstrates proper GitHub PR automation via .github/pr-placeholders/
• Score Impact: +1.5% (automated workflow)

standard_layout (Tier 1, 10% weight)

• Status: AFFECTED BY THIS PR
• Current Implementation: Lines 46-48 in src/agentready/assessors/structure.py hardcode src/ requirement
• Proposed Change: Accept project-named directories (pandas/, numpy/, sklearn/)

Code Quality Assessment

File: .github/pr-placeholders/issue-246.md (+5 lines)

Quality Score: ✅ EXCELLENT

• Minimal placeholder file (5 lines)
• Clear automation marker
• No security issues
• Static markdown content

Security Analysis

Security Score: ✅ PASS (No Issues)

• No executable code
• No sensitive data
• No injection vectors
• No dependencies

Best Practices Review

Strengths

1. Automated Workflow: Good CI/CD practices with auto-generated draft PR
2. Draft Status: Correctly marked as [Draft] for discussion
3. Context Preservation: PR body includes full issue context

Areas for Improvement (BLOCKING)

1. Missing Implementation

This PR only contains placeholder file, not actual implementation.

Expected Changes:

• Modify src/agentready/assessors/structure.py:46-48
• Accept both src/ and project-named directories
• Detect project name from pyproject.toml or setup.py

2. Missing Tests (CRITICAL)

Need test cases for:

• Project-named directories (pandas/, numpy/)
• Hyphenated names (scikit-learn → sklearn/)
• Precedence when both src/ and project-dir exist
• Backward compatibility

3. Missing Documentation

Need updates to:

• docs/attributes.md (lines 464-477)
• CLAUDE.md
• CHANGELOG.md

Review Decision

REQUEST CHANGES ⚠️

Blocking Issues:

1. No implementation code
2. Missing test coverage
3. Missing documentation updates

Next Steps

Before removing draft status:

1. Implement StandardLayoutAssessor changes
2. Add comprehensive tests
3. Update documentation
4. Run linters: black src/ tests/ && isort src/ tests/ && ruff check src/ tests/
5. Verify no regressions: pytest && agentready assess .

References

• Issue [DISCUSSION] Reconsider src/ directory requirement? #246: Original discussion
• StandardLayoutAssessor: src/agentready/assessors/structure.py:11-111
• Test Suite: tests/unit/test_assessors_structure.py
• Research Report: docs/attributes.md:440-477

---

Reviewer: Claude Code Agent (claude-sonnet-4-5)
Review Date: 2026-01-15
Confidence: High

Generated using /review-agentready skill