CONTRIBUTING.md

Contributing to flutter_local_notifications

Contributions are welcome by submitting a PR for to be reviewed. If it's to add new features, appreciate it if you could try to maintain the architecture or try to improve on it. If you are looking to add platform-specific functionality do not add this to the cross-platform facing API (i.e. the FlutterLocalNotificationsPlugin class. The recommended approaches in this scenario are:

1. see if it can be passed as platform-specific configuration or
2. add methods to the platform-specific implementations. For example, on iOS there is an IOSFlutterLocalNotificationsPlugin class. You may notice there's a requestPermissions() method that only exists there

Please ensure that no analysis issues are found and all tests continue to pass and add/update the tests as appropriate. Most of the tests are around verifying the details sent via the platform channel.

For API docs, please try to adhere to the effective Dart documentation guidelines that can be found here.

Environment setup

flutter_local_notifications uses Melos to manage the monorepo project.

To install Melos, run the following command from a terminal/command prompt:

dart pub global activate melos

At the root of your locally cloned repository bootstrap the all dependencies and link them locally

melos bootstrap

This removes the need for providing manual dependency_overrides. There's no need to run flutter pub get either. All the packages, example app and tests will run for the locally cloned repository. The workflows setup on GitHub are also configured use Melos to validate changes. For more information on Melos, refer to its website