Conversation
Adds a short **Communicating with the User** section to AGENTS.md with two agent<->user interaction rules: 1. **Reference every pull request as a clickable link** — a markdown link to the PR (`[#123](.../pull/123)`), never a bare `#123`; same for issues and commits. 2. **Ask for input as a numbered list** — so the user can reply per number; two or more questions are always numbered. Additive only; no existing wording changed. Placed as a new H2 after `PR Review Etiquette`, before `Workflow YAML Conventions`. CRLF preserved. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Encodes the last unincorporated piece of the #228 retrospective — **§0, the cross-platform decision framework** — as a new `## Supported Development Platforms` section in AGENTS.md (before `## Devcontainer`): - **Cross-platform by default** — Windows + macOS + Linux, via WSL2/devcontainer for a consistent Linux toolchain; editing is cross-platform through the GUI regardless. - **Narrow only for a hard runtime ceiling** set by dependencies (decided per repo, before writing dev tooling) — e.g. a Home Assistant integration is Linux-only because HA Core is POSIX-only. The narrowing axis is where code *executes* for dev/testing, not where editing happens. - **Record a narrowed platform + reason in the repo** so it reads as deliberate. Additive only; CRLF preserved. Completes #228's incorporation; the section→PR mapping will be posted on #228 at close. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…og for libraries (#270) Two C# rule sharpenings in CODESTYLE.md, both from maintainer directives. **Testing Conventions** — was "xUnit with AwesomeAssertions"; now explicit: - **xUnit v3 or later** (the `xunit.v3` package, never the legacy v2 `xunit`). - **AwesomeAssertions** for every assertion; native xUnit asserts (`Assert.Equal`, `Assert.True`, ...) are not allowed. **Error Handling and Logging** — clarified that Serilog is the **application's** concrete backend, and strengthened the library rule: - A NuGet **library** depends only on `Microsoft.Extensions.Logging.Abstractions` and exposes an `ILoggerFactory` seam (settable factory defaulting to `NullLoggerFactory`, `SetFactory`/`TrySetFactory`); it **never** references Serilog or a sink. - The **application** owns the concrete logger and bridges it (`SerilogLoggerFactory`), injecting it. Reference: `LanguageTags` (`LogOptions` + `LanguageTagsCreate/LoggerFactory`). Additive/sharpening only; markdownlint clean; CRLF preserved. **Fleet audit (backlog to follow):** violators are **Utilities** (xUnit v2 + native asserts; library ships Serilog) and **AudioCleaner** (xUnit v2 + native asserts). LanguageTags, PlexCleaner, NxWitness, PhotoCleaner, MediaTools already comply. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Promotes develop to main, bringing in the latest governance/documentation updates for agent-user communication conventions, supported platform guidance, and C# testing/logging rules.
Changes:
- Add AGENTS.md guidance on linking PRs/issues/commits and asking multi-part questions as numbered lists.
- Add AGENTS.md guidance on default cross-platform support and when/why to narrow it.
- Update CODESTYLE.md C# guidance to emphasize
Microsoft.Extensions.Logging/abstractions for libraries and require xUnit v3 + AwesomeAssertions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Adds new sections for communication conventions and supported development platform guidance. |
| CODESTYLE.md | Tightens .NET guidance for logging (abstractions-first for libraries) and testing (xUnit v3 + AwesomeAssertions). |
ptr727
added a commit
that referenced
this pull request
Jul 9, 2026
…y.Instance) (#272) Two one-line doc tweaks deferred from the #271 promotion review: - **AGENTS.md** — clickable-PR-link example uses `OWNER/REPO` (no angle brackets that render oddly) instead of `<owner>/<repo>`. - **CODESTYLE.md** — the library logger seam defaults to `NullLoggerFactory.Instance` (the singleton), matching the LanguageTags `LogOptions` reference. Docs-only; markdownlint clean; CRLF preserved. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Promotion of
develop->main, batching the docs/governance PRs since the last promotion:## Communicating with the User(clickable PR links; numbered questions).## Supported Development Platforms(Retrospective: cross-platform, dev-tooling & agent-workflow learnings to encode as rules #228 §0: cross-platform by default, narrow only for a hard dependency/runtime ceiling).ILoggerFactory, not Serilog.Diff is only
AGENTS.md+CODESTYLE.md; no code.spec/validate.pygreen.🤖 Generated with Claude Code