Skip to content

Add agent configuration files and community documentation#23

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/add-agent-configuration-files
Mar 2, 2026
Merged

Add agent configuration files and community documentation#23
Malcolmnixon merged 3 commits intomainfrom
copilot/add-agent-configuration-files

Conversation

Copy link
Contributor

Copilot AI commented Mar 2, 2026

Transfers and adapts agent configuration files from TemplateDotNetLibrary and 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; no dotnet format/dotnet build for production code
  • requirements-agent.md – Treats requirements.yaml as present; CI enforcement via dotnet reqstream documented
  • software-developer.md – YAML-first: literate comment style, mandatory header block convention, .yamllint.yaml rules; no C# production code guidance
  • technical-writer.md – Explicitly lists CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md as managed files with an explicit "Don't remove" rule
  • test-developer.md – Adapted for testing via WorkflowTest.RunWorkflow(); uses WorkflowName_Scenario_ExpectedBehavior naming convention; includes [GeneratedRegex] / Assert.MatchesRegex patterns specific to this codebase

Community documentation

  • CONTRIBUTING.md – Drops NuGet/production C# sections; adds YAML workflow coding standards; updates build commands to dotnet test against the test project
  • SECURITY.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 updated

AGENTS.md

Quick-reference reflecting the YAML + C# tests stack, all five agents, and the full set of community docs. Includes:

  • requirements.yaml listed in Key Files (treated as present)
  • Test naming convention updated to WorkflowName_Scenario_ExpectedBehavior
  • Documentation section aligned with template: User Guide (docs/guide/guide.md), Requirements (requirements.yaml → auto-generated docs), Build Notes (auto-generated via BuildMark), and a note that CHANGELOG.md is 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.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Add agent configuration files and update documentation Add agent configuration files and community documentation Mar 2, 2026
AGENTS.md Outdated

## Requirements

- Requirements will be tracked in `requirements.yaml` (to be added)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't put the "to be added" stuff in - this document should act as if the requirements exist.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't put the "once introduced" in.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in 6ea5441.

AGENTS.md Outdated

## Testing

- **Test Naming**: `ClassName_MethodUnderTest_Scenario_ExpectedBehavior` for unit tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests are testing workflows, so I think the convention should be changed to WorkflowName_Scenario_ExpectedBehavior.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 2, 2026 01:43
@Malcolmnixon Malcolmnixon merged commit a6bb697 into main Mar 2, 2026
4 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/add-agent-configuration-files branch March 2, 2026 01:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants