45 lines (35 loc) · 1.44 KB

Contributing

Thanks for considering contributions. This file contains minimal, practical guidelines to help changes land quickly and safely.

Local setup

Ensure a compatible Flutter SDK is installed (see pubspec.yaml environment).
From the repository root:

flutter pub get
flutter analyze
flutter test

To run the example app:

cd example
flutter run

Making changes

Keep changes small and focused. One logical change per pull request makes reviews faster.
Prefer clear commit messages and a short PR description that explains why the change is needed and how to test it.

Pre-PR checklist

Run flutter analyze and flutter test locally before opening a PR.
If you change public API or runtime behavior, update README and any relevant documentation together with the change.
If your change affects Android or iOS specifics, document the platform impact and how you validated it (device/OS/firmware used).

Communication

For larger or breaking changes, open an issue or discussion first to describe the approach and get feedback.
Be constructive and respectful in reviews and issues—we aim for pragmatic collaboration.

Other notes

No special branching or release process is required for contributions; follow the repo's existing workflow.
If in doubt, open an issue to ask before implementing a large change.

Thank you for contributing!