Add AGENTS.md for Codex (testing)

Author: mkht

Public/Realtime/AGENTS.md

@@ -0,0 +1,17 @@
+## Code Style
+- Follow the PSScriptAnalyzer rules
+- Use `Invoke-ScriptAnalyzer -Settings PSScriptAnalyzerSettings.psd1` to check your code against the project's settings
+- When you create a new file, should use CRLF line endings and UTF-8 encoding.
+
+## Testing
+- Run `Invoke-Pester -Tag Offilne`
+- Ignore warning messages in tests. it's normal to have some warnings
+- It will spend long time to run all tests, so run only the ones you need
+- When you edit only comments, readme, or other non-code files, you can skip the tests
+
+## Documentation
+- Update the cmdlet help files in `/Docs` if you add new parameters or change the behavior of existing cmdlets
+- After updating the help files, run `New-ExternalHelp -Path ./Docs/ -OutputPath ./PSOpenAI-Help.xml -Force` to build the help xml file.
+
+## References
+- This project is PowerShell wrapper for OpenAI API, so you can refer to the [OpenAI API documentation](https://platform.openai.com/docs/api-reference) for details on how the API works.

publish.ps1

@@ -11,7 +11,7 @@ Param (
 
     [Parameter(Mandatory = $false)]
     [ValidateNotNullOrEmpty()]
-    [string[]]$ExcludeFiles = @('.gitignore', '.gitmodules', '.gitattributes', 'PSScriptAnalyzerRules.psd1'),
+    [string[]]$ExcludeFiles = @('.gitignore', '.gitmodules', '.gitattributes', 'PSScriptAnalyzerRules.psd1', 'AGENTS.md'),
 
     [switch]$WhatIf
 )