Skip to content

Add AGENTS.md for LLM coding agents and update Python requirement to 3.8+#4

Merged
tcardosoMSFT merged 3 commits intomasterfrom
copilot/documentar-item
Mar 3, 2026
Merged

Add AGENTS.md for LLM coding agents and update Python requirement to 3.8+#4
tcardosoMSFT merged 3 commits intomasterfrom
copilot/documentar-item

Conversation

Copy link
Contributor

Copilot AI commented Dec 11, 2025

Added comprehensive technical documentation for LLM coding agents to complement existing human-focused README.

Changes

  • Created AGENTS.md (576 lines)

    • Architecture patterns: parallel execution with ThreadPoolExecutor, CONFIG dict pattern, subprocess-based GitHub CLI integration
    • Detailed function-level documentation for all 3 main assessment scripts (security, IDP, Copilot)
    • CSV output schemas, GitHub API endpoints, rate limiting implementation
    • Code modification examples, common patterns, troubleshooting guide
  • Updated Python requirement: 3.7+ → 3.8+ (3.7 reached EOL June 2023)

  • Enhanced README.md

    • Added Quick Links section referencing AGENTS.md
    • Fixed repository URL placeholder
    • Added AI/LLM developers section in Contributing

Documentation Coverage

All 6 Python scripts documented with architecture details:

  • security_assessment.py (695 lines): Code scanning, secret scanning, Dependabot, branch protection
  • idp_assessment.py (609 lines): SSO, 2FA, permissions, environment segregation, token security
  • assess_copilot_repos.py (412 lines): .github/ directory structure validation
  • Utility scripts: list_repos_gh_cli.py, list_repos_gh_cli_optimized.py, list_and_check_repos.py

Audience Separation

  • README.md: Human developers, security teams, repository owners
  • AGENTS.md: LLM coding agents, AI development tools requiring deep codebase understanding
Original prompt

Me ajude a documentar este item.

Custom agent used: doc-writer
Focuses on updating and writing docs for a given repository


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 11, 2025 15:17
Co-authored-by: tcardosoMSFT <17726346+tcardosoMSFT@users.noreply.github.com>
…eholder

Co-authored-by: tcardosoMSFT <17726346+tcardosoMSFT@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for the specified item Add AGENTS.md for LLM coding agents and update Python requirement to 3.8+ Dec 11, 2025
Copilot AI requested a review from tcardosoMSFT December 11, 2025 15:25
@tcardosoMSFT tcardosoMSFT requested a review from Copilot December 11, 2025 17:06
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive technical documentation for LLM coding agents and updates Python requirements. The changes separate documentation concerns between human developers (README.md) and AI agents (AGENTS.md), while addressing outdated Python version requirements.

Key Changes:

  • Created AGENTS.md with 576 lines of detailed technical documentation covering architecture patterns, function-level documentation, API endpoints, and development guidelines
  • Updated Python requirement from 3.7+ to 3.8+ to reflect that Python 3.7 reached EOL in June 2023
  • Enhanced README.md with Quick Links section, fixed repository URL placeholder, and added AI/LLM developers section

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Added Quick Links section, updated Python version to 3.8+, fixed repository URL, added AI/LLM developer contributing section, updated project structure to reference AGENTS.md
AGENTS.md New comprehensive technical documentation for LLM coding agents including architecture patterns, function documentation, CSV schemas, API endpoints, development guidelines, and troubleshooting

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## Development Guidelines

### Prerequisites
- Python 3.8 or higher (Python 3.7 reached EOL in June 2023)
Copy link

Copilot AI Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation states "Python 3.7 reached EOL June 2023" but should specify "in June 2023" for grammatical correctness.

Copilot uses AI. Check for mistakes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

@tcardosoMSFT tcardosoMSFT marked this pull request as ready for review March 3, 2026 22:14
@tcardosoMSFT tcardosoMSFT merged commit a709000 into master Mar 3, 2026
6 of 7 checks passed
@tcardosoMSFT tcardosoMSFT deleted the copilot/documentar-item branch March 3, 2026 22:15
Copilot stopped work on behalf of tcardosoMSFT due to an error March 3, 2026 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants