Re-sync governance docs and code style from template - #756
Merged
Conversation
Re-sync the verbatim-carry artifacts and governance from the current ptr727/ProjectTemplate main, adapted for PlexCleaner: - AGENTS.md: re-synced to the template structure - new Release Model with the current versioning policy (bump version.json only for functional changes; no post-release bump, no develop-ahead requirement), Documentation Style Conventions (incl. the Comments house-rule), PR Review Etiquette / Expected Review Loop carried verbatim, Workflow YAML Conventions, and a Project Structure that points to ARCHITECTURE.md. - .github/copilot-instructions.md: trimmed to the narrow template shape (commit/PR-title summary + Copilot review runbook); project-specific content relocated. - ARCHITECTURE.md: new - holds PlexCleaner's architecture, processing pipeline, and design patterns (relocated from copilot-instructions.md), referenced from AGENTS.md and copilot-instructions.md. - CODESTYLE.md: re-synced (General + .NET sections), adapted to this repo. - .editorconfig: add the .NET-only boundary marker and suppressions note. - .markdownlint-cli2.jsonc: align the MD060 comment to the template. Closes#731. Addresses #745 (docs portions; workflow conventions follow). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR re-syncs PlexCleaner’s governance and contributor-facing documentation with the upstream ptr727/ProjectTemplate, consolidating project conventions into AGENTS.md/CODESTYLE.md, moving architecture guidance into a new ARCHITECTURE.md, and slimming .github/copilot-instructions.md down to Copilot-specific mechanics.
Changes:
- Reworked
AGENTS.mdto the newer template structure (release model/versioning policy, doc/comment conventions, review-loop contract, workflow-YAML conventions, project structure). - Re-synced
CODESTYLE.mdand introducedARCHITECTURE.mdas the central architecture/pipeline/design reference. - Aligned repo-wide lint/config scaffolding (
.editorconfig,.markdownlint-cli2.jsonc) and trimmed Copilot instructions to the narrow runbook shape.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
AGENTS.md | Re-synced governance/review-loop/release-model documentation and workflow conventions. |
CODESTYLE.md | Re-synced code style guide; documents .NET clean-compile tasks and coding conventions. |
ARCHITECTURE.md | New consolidated architecture + pipeline + patterns document. |
.github/copilot-instructions.md | Slimmed to commit/PR-title summary + Copilot review runbook; links out to AGENTS/CODESTYLE/ARCHITECTURE. |
.editorconfig | Clarified JSON/JSONC block and added .NET-only boundary marker + suppression guidance note. |
.markdownlint-cli2.jsonc | Updated MD060 comment to match template wording. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- .vscode/tasks.json: add dependsOrder: sequence to .Net Format so the clean-compile actually chains CSharpier Format -> .Net Build -> verify (matches the template and the documented behavior). - CODESTYLE.md: reference GlobalUsing.cs (this repo's actual file name). - ARCHITECTURE.md: drop var from the builder example (CODESTYLE bans it), rename the colliding identifier, and use dotnet csharpier format. - AGENTS.md: correct the merge-bot description to this repo's behavior (gates on PR author so maintainer repair commits still auto-merge; default cancel-in-progress, so only publish-release is a concurrency exception). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Uh oh!
There was an error while loading. Please reload this page.
This repo SHA-pins dotnet/nbgv like every other action; drop the template's @master no-pin exception, which does not apply here. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Use the actual VS Code task label .Net Build, and the canonical CSharpier Format invocation (dotnet csharpier format --log-level=debug). 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 freeto 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.
Re-sync the verbatim-carry artifacts and governance from the current ptr727/ProjectTemplate
main, adapted for PlexCleaner. Docs-and-policy portion of the template reconverge; workflow conventions follow in a second PR.Changes
AGENTS.md- re-synced to the current template structure: a Release Model section carrying the new versioning policy (bumpversion.jsononly for functional changes; no post-release bump and no develop-ahead requirement - NBGV advances the patch automatically), Documentation Style Conventions (incl. the Comments house-rule and Character Set), PR Review Etiquette / Expected Review Loop carried verbatim, Workflow YAML Conventions, and a Project Structure that points to the newARCHITECTURE.md. Drops the old "bump minor after every develop->main merge / keep develop ahead" ritual..github/copilot-instructions.md- trimmed from 597 to ~156 lines to the narrow template shape (commit/PR-title summary + the GitHub Copilot review runbook). Project-specific content relocated.ARCHITECTURE.md(new) - PlexCleaner's architecture, processing pipeline, and design patterns (relocated fromcopilot-instructions.md); referenced fromAGENTS.mdandcopilot-instructions.mdso agents and Copilot discover it.CODESTYLE.md- re-synced from the template (General + .NET sections), adapted to this repo's projects,InternalsVisibleTo, and VS Code task labels..editorconfig- add the ".NET-only" boundary marker and the analyzer-suppressions note; align the JSON comment..markdownlint-cli2.jsonc- align the MD060 comment to the template.All docs are ASCII, CRLF, and markdownlint-clean.
Closes#731. Addresses #745 (docs portions; workflow conventions in the follow-up PR).
🤖 Generated with Claude Code