Found a bug? Got a question? Want some enhancement?
First place to go is the repository issues section, and I'll try to help as much as possible.
Fixed a bug or just want to provided additional functionality?
Simply fork this repository, implement your changes and create a pull request.
Few guidelines regarding pull requests:
- This repository is integrated with github actions for continuous integration.
Your pull request build must pass (the build will run automatically).
You can run the following command locally to ensure the build will pass:
cargo make ci-flow-
There are many automatic unit tests as part of the library which provide full coverage of the functionality.
Any fix/enhancement must come with a set of tests to ensure it's working well. -
For Windows users: Few windows specific tests run powershell scripts via cargo-make to test powershell support. For those tests to pass, you need to allow to run PowerShell scripts (see About Execution Policies for more info). Run in PS:
Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser