We welcome and appreciate contributions from the community. Please read this document for different ways of getting involved with the sdk-powershell.
- Ensure that the issue you are about to file is not already open. If someone has already opened a similar issue, please leave a comment or add a GitHub reaction to the top comment to express your interest.
- If you can't find your issue already, open a new issue.
CloudEvents.SDK PowerShell consists of a .NET project that resolves the CloudEvents sdk-csharp dependency, PowerShell script module with the sdk advanced functions, and Pester tests.
- .NET 5.0 SDK
- PowerShell 7.0 or higher
- Pester 5.1.1 or higher
The CloudEvents.Sdk module source code is in the src directory. We have unit tests and localhost integration tests available in the test directory.
The build.ps1 script is the entry point to build the module and run the tests. It has two parameters
1. OutputDir - The destination directory for the CloudEvents.Sdk module
2. TestsType - Specifies which tests (none | unit | integration | all) to run on successful module build.
Running the build.ps1 without specifying parameters produce the module in a CloudEvents.Sdk directory under the repository root directory, and runs all tests.
Anyone can fork the repository into their own user account, where they can make private changes. To contribute your changes back create a pull request. A pull request should relate to an existing issue.
Adding new features or fixing bugs might require adding or updating tests. Before creating a pull request make sure all tests pass locally.