Repository navigation
Update AGENTS.md and move the coding guidelines into docs/guidelines - #6135
Open
danielmarbach wants to merge 3 commits into
Open
danielmarbach wants to merge 3 commits into
danielmarbach wants to merge 3 commits into
Conversation
Takes AGENTS.md unchanged from Particular/Platform@c0a82fc. The Code changes workflow now reads the guidelines the docs index lists, requires a Guidelines: line in the change description, and asks docs pages to describe the current design. Adds the Guidelines and skills section.
Splits docs/coding-and-design-guidelines.md into three guidelines that each state when they apply, and lists them in docs/README.md. The rules follow the current code: the instances run on the Generic Host with the Microsoft container and log through ILogger<T>. Links the NServiceBus logging guidance as an upstream contract.
danielmarbach
requested review from
abparticular,
johnsimons,
rbev and
warwickschroeder
November 13, 2026 16:38
danielmarbach
commented
Nov 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates
AGENTS.mdto the current engineering context template, copied unchanged from Particular/Platform@c0a82fc (Platform#1700), and movesdocs/coding-and-design-guidelines.mdinto the guideline structure the template describes.Guidelines
The page becomes three guidelines under
docs/guidelines/, each stating when it applies and listed indocs/README.md:microsoft-abstractions.mdexplicit-container-registration.mdexplicit-persistence-operations.mdThe persistence guideline keeps its rules unchanged. The other two follow the current code:
src/ServiceControl.Config, which the guidelines exclude.IHostApplicationBuilderinstead ofIHostBuilder.ILogger<T>in 126 files andLogManagerin one, so the guideline says new code should useILogger<T>. This follows the NServiceBus logging guidance, now listed as an upstream contract.The guidelines do not adopt
[LoggerMessage]source generation, which the NServiceBus guidance prefers. No ServiceControl file uses it today.Docs and guidelines
docs/README.mdanddocs/coding-and-design-guidelines.md.docs/README.mdnow lists the guidelines and upstream contracts and no longer links the moved page.