Add AGENTS.md, development-workflow skill, and dev-docs/ADR structure#531
Merged
Conversation
Introduce repository guidance for AI agents and contributors: - AGENTS.md: project overview, build/test commands, central package management, target frameworks, code style, and the two agent-skill locations. - development-workflow skill: mandatory TDD (Red-Green-Refactor), ADR policy, and docs-vs-dev-docs split. - dev-docs/: implementer documentation home (not published) with an ADR template, index, and initial ADR-0001. - skills/: home for published, user-facing ReactiveProperty consumer skills. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
2 participants
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.
Why
The repo had no single place describing how to build, test, and contribute, nor an agreed development workflow or a home for design decisions. This adds that guidance so both humans and AI coding agents can work consistently.
What's included
AGENTS.md— repo guide grounded in the actual config: project overview, build/test commands (dotnet restore/build/test ReactiveProperty.slnx, .NET 10 SDK, Windows required for WPF/UWP), Central Package Management rule, per-project target frameworks,Reactive.Bindingsroot namespace, signing, versioning, and.editorconfigcode style.development-workflowskill (.agents/skills/development-workflow/SKILL.md) — the team policy: mandatory TDD (Red -> Green -> Refactor), recording design decisions as ADRs, and the documentation split by audience.dev-docs/— a new top-level home for implementer/contributor documentation, intentionally separate from the published VuePressdocs/site (so internal notes are not published). Includes an ADR index, a Nygard-style template, and0001-adopt-tdd-adr-and-dev-docs.mdrecording these decisions.skills/— a home for published, user-facing ReactiveProperty consumer skills, with a README explaining how it differs from.agents/skills/.Notes for reviewers
.agents/skills/is for working on the library (auto-loaded for repo work);skills/is for people using ReactiveProperty in their apps (distributed to consumers, not auto-loaded here). This split is documented inAGENTS.md.dev-docs/andskills/was chosen with the maintainer; both sit outsidedocs/so VuePress does not publish them and no VuePress config change is needed.Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com