Add agent configuration files and community documentation#23
Add agent configuration files and community documentation#23Malcolmnixon merged 3 commits intomainfrom
Conversation
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
AGENTS.md
Outdated
|
|
||
| ## Requirements | ||
|
|
||
| - Requirements will be tracked in `requirements.yaml` (to be added) |
There was a problem hiding this comment.
Don't put the "to be added" stuff in - this document should act as if the requirements exist.
There was a problem hiding this comment.
Done in 6ea5441 — removed the "to be added" qualifier and added requirements.yaml to the Key Files section as an already-present file.
AGENTS.md
Outdated
| ## Requirements | ||
|
|
||
| - Requirements will be tracked in `requirements.yaml` (to be added) | ||
| - All requirements MUST be linked to tests once introduced |
There was a problem hiding this comment.
Don't put the "once introduced" in.
AGENTS.md
Outdated
|
|
||
| ## Testing | ||
|
|
||
| - **Test Naming**: `ClassName_MethodUnderTest_Scenario_ExpectedBehavior` for unit tests |
There was a problem hiding this comment.
The tests are testing workflows, so I think the convention should be changed to WorkflowName_Scenario_ExpectedBehavior.
There was a problem hiding this comment.
Updated in 6ea5441 — changed to WorkflowName_Scenario_ExpectedBehavior in both AGENTS.md and test-developer.md (including the example method name and naming convention description).
|
|
||
| ## Documentation | ||
|
|
||
| - **README.md**: Usage guide for the workflows |
There was a problem hiding this comment.
This section seems different from the template in https://github.com/demaconsulting/TemplateDotNetLibrary/blob/main/AGENTS.md
You're not mentioning the user guide.
Also add the requirements.yaml -> autogenerated docs (even though its not there yet)
Also add the Build Notes
Also mention there is no CHANGELOG.md as changes are captured in the auto-generated build notes.
There was a problem hiding this comment.
Updated in 6ea5441 — the Documentation section now lists: User Guide (docs/guide/guide.md), README, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT, Requirements (requirements.yaml → auto-generated docs), Build Notes (auto-generated via BuildMark), and a note that CHANGELOG.md is absent as changes are in the auto-generated build notes.
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Transfers and adapts agent configuration files from
TemplateDotNetLibraryand adds standard community docs, adjusted for a repo that contains only SPDX workflow YAML files and C# MSTest V4 tests (no C# production code).Agent files (
.github/agents/)code-quality-agent.md– Scoped to YAML linting + C# test build; nodotnet format/dotnet buildfor production coderequirements-agent.md– Treatsrequirements.yamlas present; CI enforcement viadotnet reqstreamdocumentedsoftware-developer.md– YAML-first: literate comment style, mandatory header block convention,.yamllint.yamlrules; no C# production code guidancetechnical-writer.md– Explicitly listsCONTRIBUTING.md,SECURITY.md,CODE_OF_CONDUCT.mdas managed files with an explicit "Don't remove" ruletest-developer.md– Adapted for testing viaWorkflowTest.RunWorkflow(); usesWorkflowName_Scenario_ExpectedBehaviornaming convention; includes[GeneratedRegex]/Assert.MatchesRegexpatterns specific to this codebaseCommunity documentation
CONTRIBUTING.md– Drops NuGet/production C# sections; adds YAML workflow coding standards; updates build commands todotnet testagainst the test projectSECURITY.md– Replaces library-usage section with a workflow integrity section (integrity hash pinning)CODE_OF_CONDUCT.md– Standard Contributor Covenant 2.1; only repo URLs updatedAGENTS.mdQuick-reference reflecting the YAML + C# tests stack, all five agents, and the full set of community docs. Includes:
requirements.yamllisted in Key Files (treated as present)WorkflowName_Scenario_ExpectedBehaviordocs/guide/guide.md), Requirements (requirements.yaml→ auto-generated docs), Build Notes (auto-generated via BuildMark), and a note thatCHANGELOG.mdis absent as changes are captured in auto-generated build notes💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.