Skip to content

chore(AIAgents): organize agent guidance docs - #8685

Merged
ArgoZhang merged 1 commit into
mainfrom
dev-agents
Nov 6, 2026
Merged

ArgoZhang merged 1 commit into
mainfrom
dev-agents

Conversation

@ArgoZhang

@ArgoZhang ArgoZhang commented Nov 6, 2026 •

Copy link
Copy Markdown
Member

Link issues

fixes #8684

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Reorganize repository guidance for AI agents into a concise central policy with task-specific documentation.

Enhancements:

  • Organize AI agent guidance into a concise root policy with focused reference documents for dependencies, components, commits, and pull requests.

Documentation:

  • Add structured documentation covering component standards, dependency handling, commit messages, and pull request practices.

Chores:

  • Remove the obsolete reproduction document and update ignore configuration.

@sourcery-ai

sourcery-ai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Reorganizes AI agent guidance by slimming down AGENTS.md and introducing focused component, dependency, and PR documentation, while also removing obsolete reproduction documentation and updating ignore rules.

File-Level Changes

Change Details Files
Refactor the root agent instructions into a concise entry point and move specialized guidance into linked documents.
  • Retain core C# and Razor conventions plus AI-specific prohibitions in the root guide.
  • Add component, dependency, and PR/commit guidance documents with their respective detailed workflows and checklists.
  • Reference the specialized documents from the root guide for on-demand reading.
AGENTS.md
docs/agents/component-checklist.md
docs/agents/dependencies.md
docs/agents/pr-guide.md
docs/agents/commit_msg_template.md
Remove an obsolete documentation file and update ignore configuration.
  • Delete the existing reproduction documentation.
  • Adjust repository ignore rules.
docs/repro.md
.gitignore

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added the chore This are tasks or bot action label Nov 6, 2026
@bb-auto bb-auto Bot added this to the v11.1.0 milestone Nov 6, 2026

@bb-auto bb-auto Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto approved by bb-auto

@ArgoZhang
ArgoZhang merged commit 60abd79 into main Nov 6, 2026
4 checks passed
@ArgoZhang
ArgoZhang deleted the dev-agents branch November 6, 2026 03:52

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Linked issues

#8684 chore(AIAgents): organize agent guidance docs · 1 of 1 met

# Requirement Status Notes
1 Organize agent guidance docs ✅ Met The root AGENTS.md provides concise guidance and links to focused documents for component standards, dependencies, and PR practices; commit message guidance is also separated.

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@codecov

codecov Bot commented Nov 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (a576f09) to head (47160c4).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #8685   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          776       776           
  Lines        35231     35231           
=========================================
  Hits         35231     35231           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore This are tasks or bot action

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(AIAgents): organize agent guidance docs

1 participant