Skip to content

Distill AGENTS.md to project-specific conventions and recent review patterns#30

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/update-agents-md-with-reviews
Jan 9, 2026
Merged

Distill AGENTS.md to project-specific conventions and recent review patterns#30
Malcolmnixon merged 4 commits intomainfrom
copilot/update-agents-md-with-reviews

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 9, 2026

Update AGENTS.md with Recent Review Decisions - Complete ✅

Successfully updated AGENTS.md to reflect review decisions from recent PRs and streamlined content for better readability.

Changes Made:

  • Reduced file from 361 to 192 lines (47% reduction)
  • Added key review decisions from PRs Add Context class for command-line argument parsing and program output #22, Implement Program.cs with command processing and exception handling #24, [WIP] Review software quality and address build warnings #29
  • Added XmlDoc indentation requirement (spaces after ///)
  • Added exception handling patterns (parsing vs runtime errors)
  • Added code reusability guidance (properties vs repeated code)
  • Added version output format (plain text only)
  • Added application banner consistency pattern
  • Added Console.Out save/restore pattern for tests
  • Added MSTest v4 API usage (Assert.HasCount, Assert.IsEmpty, Assert.DoesNotContain)
  • Streamlined testing guidelines (removed verbose redundant content)
  • Simplified code style section (kept project-specific items)
  • Condensed quality standards (removed obvious items)
  • Simplified CI/CD section (kept essentials only)
  • Replaced verbose "Boundaries" section with concise "What NOT to Do"
  • Created "Project-Specific Guidelines" section with review decisions
  • Fixed markdown linting errors (blank lines around code blocks, trailing spaces)
  • Changed test parallelization to DoNotParallelize to prevent console output conflicts

Quality Checks Completed:

  • Build succeeded: 0 warnings, 0 errors
  • All tests passed: 127/127 tests passing
  • Code review: No issues found
  • Security scan: No code changes to analyze
  • Markdown linting: All issues fixed
  • Test parallelization: Fixed to prevent intermittent failures

Summary:

The updated AGENTS.md now focuses on ReqStream-specific conventions and important review patterns that have emerged from actual code reviews. Removed generic best practices that competent AI agents already know, making the document more useful as a quick reference for project-specific decisions.

Key Improvements:

  • More concise and scannable format
  • Highlights actual review decisions from merged PRs
  • Easier to find project-specific requirements
  • Reduced LLM token usage by 47%
  • Fixed test parallelization to prevent console output conflicts
Original prompt

Please review the recent pull requests and the corresponding feedback, and update the AGENTS.md to reflect the corresponding review decisions. Additionally to keep the LLM window small, consider removing overly verbose content from the AGENTS.md file for rules that any competent AI coding agent would already follow.

Custom agent used: Software Quality Enforcer
Expert agent for code quality, testing standards, code reviews, security analysis, and ensuring adherence to coding conventions


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Malcolmnixon Malcolmnixon marked this pull request as ready for review January 9, 2026 00:55
@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot Please fix the quality check failures:

Error: AGENTS.md:65 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```csharp"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md031.md
Error: AGENTS.md:69 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md031.md
Error: AGENTS.md:95 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```csharp"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md031.md
Error: AGENTS.md:99 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md031.md
Error: AGENTS.md:115:21 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md009.md
Error: AGENTS.md:126 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **build_on_push.yaml**: Runs..."] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md032.md
Error: AGENTS.md:130 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md031.md

Copilot AI changed the title [WIP] Update AGENTS.md with recent review decisions Distill AGENTS.md to project-specific conventions and recent review patterns Jan 9, 2026
Copilot AI requested a review from Malcolmnixon January 9, 2026 00:57
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 9, 2026

@copilot Please fix the quality check failures:

Error: AGENTS.md:65 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```csharp"] https://github.com/Da...

Fixed all markdown linting errors in commit 0c91a5b:

  • Added blank lines around all fenced code blocks
  • Removed trailing space from line 115
  • Added blank line before list on line 126

All 7 markdownlint errors have been resolved.

@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot I'm seeing periodic unit-test failures. I believe this is related to the capturing of console output in unit tests, and trying to run the unit tests in parallel. I believe the test AssemblyInfo.cs should change parallelization to [assembly: DoNotParallelize].

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 9, 2026

@copilot I'm seeing periodic unit-test failures. I believe this is related to the capturing of console output in unit tests, and trying to run the unit tests in parallel. I believe the test AssemblyIn...

Changed test parallelization from Parallelize(Workers = 0, Scope = ExecutionScope.ClassLevel) to [assembly: DoNotParallelize] in commit 19de980. All 127 tests pass successfully with the new configuration. This should resolve the periodic failures related to console output capturing.

@Malcolmnixon Malcolmnixon merged commit a1cb014 into main Jan 9, 2026
12 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-agents-md-with-reviews branch January 9, 2026 01:55
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.

2 participants