diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 09de568613..d6550ee210 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,15 @@ ## Description -*Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, and what motivated the change.* + ## Related Issues -*Replace this paragraph with a list of issues related to this PR from the [issue database](https://github.com/fluttercommunity/plus_plugins/issues). Indicate, which of these issues are resolved or fixed by this PR.* + ## Checklist diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ccb130f40..88a33b6e1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,9 @@ _See also: [Flutter's code of conduct](https://flutter.dev/design-principles/#co We welcome all contributions to the project, however some contributions will need extra work in order to be accepted. +> [!IMPORTANT] +> Before submitting a large PR, create a ticket with a proposal and wait for the maintainers to give you feedback. + Here's some examples: ### 🟢 Easily accepted contributions @@ -85,6 +88,7 @@ The bootstrap command locally links all dependencies within the project without provide manual [`dependency_overrides`](https://dart.dev/tools/pub/pubspec). This allows all plugins, examples and tests to build from the local clone project. +> [!TIP] > You do not need to run `flutter pub get` once bootstrap has been completed. ## 4. Running an example @@ -172,14 +176,15 @@ file. We gladly accept contributions via GitHub pull requests. -Please peruse the +Please follow the [Flutter style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo) and [design principles](https://flutter.dev/design-principles/) before working on anything non-trivial. These guidelines are intended to keep the code consistent and avoid common pitfalls. -**Important:** When modifying multiple packages, **create a different branch and pull request per package.** -This facilitates maintenance, the review process, and generating changelogs. +> [!IMPORTANT] +> When modifying multiple packages, **create a different branch and pull request per package.** +> This facilitates maintenance, the review process, and generating changelogs. ### 5.1 Getting started @@ -202,9 +207,10 @@ melos run analyze melos run format ``` -### 5.3 (Do not) Update version and changelog +### 5.3 Do not update version and changelog -**NEW: Do not modify the CHANGELOG.md or the version in the pubspec.yaml, this is handled by the maintainers from now on** +> [!CAUTION] +> Do not modify the `CHANGELOG.md` or the version in the `pubspec.yaml`, this is handled by the maintainers from now on ### 5.4 Commit and push your changes @@ -231,6 +237,9 @@ guide, and include the package name in parenthesis. For example, for a fix to th Please also enable **“Allow edits by maintainers”**, this will help to speed-up the review process as well. +> [!TIP] +> Ensure the PR description is filled correctly and the markdown looks correctly. + ### 5.6 Now be patient :) Plugins tests are run automatically on contributions using GitHub Actions. Depending on diff --git a/packages/package_info_plus/package_info_plus/README.md b/packages/package_info_plus/package_info_plus/README.md index d977a94570..638d1ab20d 100644 --- a/packages/package_info_plus/package_info_plus/README.md +++ b/packages/package_info_plus/package_info_plus/README.md @@ -76,7 +76,7 @@ See https://github.com/fluttercommunity/plus_plugins/issues/309 #### I see wrong version on Windows platform There was an [issue](https://github.com/flutter/flutter/issues/73652) in Flutter, which is already resolved since Flutter 3.3. -If your project was created before Flutter 3.3 you need to migrate the project according to [this guide] (https://docs.flutter.dev/release/breaking-changes/windows-version-information) first to get correct version with `package_info_plus` +If your project was created before Flutter 3.3 you need to migrate the project according to [this guide](https://docs.flutter.dev/release/breaking-changes/windows-version-information) first to get correct version with `package_info_plus` ### Web diff --git a/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart b/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart index 2374733d7d..db609f60a9 100644 --- a/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart +++ b/packages/package_info_plus/package_info_plus/lib/package_info_plus.dart @@ -54,8 +54,8 @@ class PackageInfo { /// /// With this, the package will try to search the file in `https://cdn.domain.com/with/some/path/version.json` /// - /// * The second option where it will search is the [assetBase] parameter - /// that you can pass to the Flutter Web Engine when you initialize it. + /// * The second option where it will search is the [assetBase](https://docs.flutter.dev/platform-integration/web/initialization#customize-the-flutter-loader) + /// parameter that you can pass to the Flutter Web Engine when you initialize it. /// /// ```javascript /// _flutter.loader.loadEntrypoint({