Skip to content

chore: Add Agentic AI development assets for GitHub Copilot #306

Description

@PlagueHO

Summary

Add Agentic AI development assets so that GitHub Copilot (agent mode) and other AI coding agents can build, test, and contribute to this repository correctly — following DSC Community conventions and StorageDsc-specific patterns.


Files to create

1. AGENTS.md (repository root)

  • Repository overview — storage management DSC resources, supported Windows versions
  • Resource type — MOF-based resources in source/DSCResources/
  • Build commands:
    ./build.ps1 -Tasks noop   # one-time setup per pwsh session
    ./build.ps1 -Tasks build
    Invoke-Pester -Path 'tests/Unit' -Output Detailed
  • Never run integration tests locally — CI only
  • DSC Community resourcesGuidelines, Blog Posts

2. tests/AGENTS.md

  • Pester 5 syntax required; Pester 4 must not be used
  • Key differences: Should -Invoke, Should -BeTrue, BeforeDiscovery, $PSDefaultParameterValues
  • Unit tests: tests/Unit/DSCResources/; Integration tests: tests/Integration/ (CI only)
  • Required DscResource.Test bootstrap boilerplate

3. .github/copilot-instructions.md

4. .github/instructions/*.instructions.md

Copy and adapt from SqlServerDsc .github/instructions/:

New file Adaptations
dsc-community-style-guidelines.instructions.md DSCResources layout; MOF-only
dsc-community-style-guidelines-mof-resources.instructions.md Copy as-is
dsc-community-style-guidelines-pester.instructions.md Copy as-is
dsc-community-style-guidelines-unit-tests.instructions.md StorageDsc; tests/Unit/DSCResources/; no SMO
dsc-community-style-guidelines-integration-tests.instructions.md StorageDsc; tests/Integration/; no SQL CI notes
dsc-community-style-guidelines-powershell.instructions.md Copy as-is
dsc-community-style-guidelines-localization.instructions.md MOF resource string paths
dsc-community-style-guidelines-changelog.instructions.md dsccommunity/StorageDsc repo URL
dsc-community-style-guidelines-markdown.instructions.md Copy as-is
StorageDsc-guidelines.instructions.md StorageDsc-specific: build/test workflow, MOF naming, no SQL/SMO; applyTo: "**"

Acceptance criteria

  • AGENTS.md created at repository root
  • tests/AGENTS.md created
  • .github/copilot-instructions.md created
  • All 10 .github/instructions/*.instructions.md files created with no SQL Server–specific content

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions