Before starting work on the repository please configure the environment and emulators.
- Install Flutter using instruction for your OS.
- Follow official recommendations about setting up IDE.
In the example folder you can find the demo application. Read the instruction on how to start the example app.
For running tests just call flutter test.
The main branch is locked for the push action. For proposing changes, use the standard pull request approach. It's recommended to discuss fixes or new functionality in the Issues, first.
The library is automatically released on every push to the main branch if there are relevant changes using semantic-release with following plugins:
- @semantic-release/commit-analyzer
- @semantic-release/release-notes-generator
- @semantic-release/changelog
- @semantic-release/github
- @semantic-release/exec
The workflow must be approved by one of the maintainers, first. The release configuration can be found in .releaserc file.
After the release is created, publish.yaml workflow is triggered that publishes the package to pub.dev