From 3623f62c1d8e5679027b609e8a9cd39a46d96c77 Mon Sep 17 00:00:00 2001 From: Rene Floor Date: Wed, 2 Jun 2021 17:40:17 +0200 Subject: [PATCH] Some small documentation fixes (#3999) * Two small documentation fixes * Fix url to plugin_tool format --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- CONTRIBUTING.md | 2 +- script/tool/README.md | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ec9a6dd6ab92..d470ac18bf5c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,7 +8,7 @@ - [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities. -- [ ] I read and followed the [Flutter Style Guide] and the [C++, Objective-C, Java style guides]. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use `dart format`. See [plugin_tool format](../script/tool/README.md#format-code)) +- [ ] I read and followed the [Flutter Style Guide] and the [C++, Objective-C, Java style guides]. (Note that unlike the flutter/flutter repo, the flutter/plugins repo does use `dart format`. See [plugin_tool format]) - [ ] I signed the [CLA]. - [ ] The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. `[shared_preferences]` - [ ] I listed at least one issue that this PR fixes in the description above. @@ -30,3 +30,4 @@ If you need help, consider asking for advice on the #hackers-new channel on [Dis [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat [pub versioning philosophy]: https://dart.dev/tools/pub/versioning +[plugin_tool format]: https://github.com/flutter/plugins/blob/master/script/tool/README.md#format-code diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83782718a023..1c4115fb640f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ _See also: [Flutter's code of conduct](https://github.com/flutter/flutter/blob/m ## Welcome For an introduction to contributing to Flutter, see [our contributor -guide][https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md]. +guide](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md). Additional resources specific to the plugins repository: - [Setting up the Plugins development diff --git a/script/tool/README.md b/script/tool/README.md index c142b66178b4..3e9484c3ff0c 100644 --- a/script/tool/README.md +++ b/script/tool/README.md @@ -58,7 +58,7 @@ Note that the `plugins` argument, despite the name, applies to any package. ```sh cd -dart run /script/tool/lib/src/main.dart format --plugins plugin_name +dart run ./script/tool/lib/src/main.dart format --plugins plugin_name ``` ### Run the Dart Static Analyzer