When contributing to this project, ensure you:

1. Review existing functions already available and reuse where possible.
2. Return native .NET objects whenever possible.
3. Rarely should you return from a function with format-table, format-list, etc.. If they do, they should use the PowerShell verb Show.
4. Environments that this module run on may be in a broken or inconcistent state, so defensive coding techniques should be leveraged.
5. Use PowerShell Approved Verbs when creating functions.
6. Provide detailed function synopsis, description, parameters and examples. The build pipeline leverages platyPS to auto-generate documentation for the exported functions and publishes to the project wiki.

When creating functions:

1. Functions should be placed under the respective module that they execute under based on the role.
2. If your function should be exported and available after module import, be sure to add your function to the export list in src\SdnDiagnostics.psd1 under FunctionsToExport.

1. To generate a local build of the module, run .\build.ps1 which will generate an SdnDiagnostics module package to ~\out\build\SdnDiagnostics.
2. Copy the module to C:\Program Files\WindowsPowerShell\Modules.
   • Remove any existing modules if they are present.
   • Folder path structure should resemble \SdnDiagnostics\{version}
3. Import the module using Import-Module -Name SdnDiagnostics -Force.
   • If you have already imported the SdnDiagnostics module and need to re-import, you first must Remove-Module -Name SdnDiagnostics and then perform the Import-Module operation. This will ensure that the nested modules, classes and enums are loaded correctly.
4. Install the modules to the SDN nodes in the dataplane.

$environmentDetails = Get-SdnInfrastructureInfo -NetworkController 'NC01'
Install-SdnDiagnostics -ComputerName $environmentDetails.FabricNodes