From dcf18dde15491d9e1a1a8c3cfb6ad1bb13e7660c Mon Sep 17 00:00:00 2001 From: Michael Bui <25263378+MaikuB@users.noreply.github.com> Date: Sun, 4 Aug 2024 21:16:00 +1000 Subject: [PATCH 1/2] added contributing guide with info on setting up environment --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bbf9c26 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +## Environment setup + +`flutter_appauth` uses [Melos](https://melos.invertase.dev) 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`](https://dart.dev/tools/pub/pubspec). 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](https://melos.invertase.dev) \ No newline at end of file From 847605f37564bc9e9c737c00b745c3567499b802 Mon Sep 17 00:00:00 2001 From: Michael Bui <25263378+MaikuB@users.noreply.github.com> Date: Sun, 4 Aug 2024 21:20:13 +1000 Subject: [PATCH 2/2] updated readme in root of repo to link to contribution guide --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4981d49..1b90f82 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,8 @@ A Flutter plugin that provides a wrapper for native AppAuth SDKs (https://appauth.io) used authenticating and authorizing users. The repository consists of the following folders - [flutter_appauth](https://github.com/MaikuB/flutter_appauth/tree/master/flutter_appauth): code for the plugin -- [flutter_appauth_platform_interface](https://github.com/MaikuB/flutter_appauth/tree/master/flutter_appauth_platform_interface): the code for common platform interface \ No newline at end of file +- [flutter_appauth_platform_interface](https://github.com/MaikuB/flutter_appauth/tree/master/flutter_appauth_platform_interface): the code for common platform interface + +## Contributing + +If you are interested in contributing, please review the [contribution guide](https://github.com/MaikuB/flutter_appauth/blob/master/CONTRIBUTING.md) \ No newline at end of file