From 8e3ce4f412d1cccb1513f260223ec00baa37ac39 Mon Sep 17 00:00:00 2001 From: Michael Goderbauer Date: Tue, 19 Apr 2022 16:39:10 -0700 Subject: [PATCH] Document how to suggest lints for flutter_lints (#1546) --- packages/flutter_lints/CHANGELOG.md | 4 ++++ packages/flutter_lints/README.md | 14 ++++++++++++++ packages/flutter_lints/pubspec.yaml | 2 +- 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/packages/flutter_lints/CHANGELOG.md b/packages/flutter_lints/CHANGELOG.md index d0613c534a..f94b1beff1 100644 --- a/packages/flutter_lints/CHANGELOG.md +++ b/packages/flutter_lints/CHANGELOG.md @@ -1,3 +1,7 @@ +## 2.0.1 + +* Updated readme to document suggestion process for new lints + ## 2.0.0 * Added the following lints: diff --git a/packages/flutter_lints/README.md b/packages/flutter_lints/README.md index acba0b59c1..8c4b2037d6 100644 --- a/packages/flutter_lints/README.md +++ b/packages/flutter_lints/README.md @@ -58,7 +58,21 @@ linter: # https://dart.dev/guides/language/analysis-options ``` +## Adding new lints + +Please file a [lint proposal] issue to suggest that an existing lint rule should +be added to this package. The benefits and risks of adding a lint should be +discussed on that issue with all stakeholders involved. The suggestions will be +reviewed periodically (typically once a year). Following a review, the package +will be updated with all lints that made the cut. + +Adding a lint to the package may create new warnings for existing users and is +therefore considered to be a breaking change, which will require a major version +bump. To keep churn low, lints are not added one-by-one, but in one batch +following a review of all accumulated suggestions since the previous review. + [Flutter]: https://flutter.dev [dart analyzer]: https://dart.dev/guides/language/analysis-options [Dart-enabled IDEs]: https://dart.dev/tools#ides-and-editors [package:lints]: https://pub.dev/packages/lints +[lint proposal]: https://github.com/dart-lang/lints/issues/new?&labels=type-lint&template=lint-propoposal.md diff --git a/packages/flutter_lints/pubspec.yaml b/packages/flutter_lints/pubspec.yaml index 35a2aea867..f0cd1e07b0 100644 --- a/packages/flutter_lints/pubspec.yaml +++ b/packages/flutter_lints/pubspec.yaml @@ -2,7 +2,7 @@ name: flutter_lints description: Recommended lints for Flutter apps, packages, and plugins to encourage good coding practices. repository: https://github.com/flutter/packages/tree/main/packages/flutter_lints issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+flutter_lints%22 -version: 2.0.0 +version: 2.0.1 environment: sdk: '>=2.17.0-0 <3.0.0'