flutter/packages
1
0
Fork 0
mirror of https://github.com/flutter/packages.git synced 2025-08-06 17:28:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document how to suggest lints for flutter_lints (#1546)

Browse Source
This commit is contained in:
Michael Goderbauer
2022-04-19 16:39:10 -07:00
committed by GitHub
parent b7cd2f4e57
commit 8e3ce4f412
3 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/flutter_lints/CHANGELOG.md
View File

@ -1,3 +1,7 @@
## 2.0.1
* Updated readme to document suggestion process for new lints
## 2.0.0 ## 2.0.0
* Added the following lints: * Added the following lints:

14
packages/flutter_lints/README.md
View File

@ -58,7 +58,21 @@ linter:
# https://dart.dev/guides/language/analysis-options # 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 [Flutter]: https://flutter.dev
[dart analyzer]: https://dart.dev/guides/language/analysis-options [dart analyzer]: https://dart.dev/guides/language/analysis-options
[Dart-enabled IDEs]: https://dart.dev/tools#ides-and-editors [Dart-enabled IDEs]: https://dart.dev/tools#ides-and-editors
[package:lints]: https://pub.dev/packages/lints [package:lints]: https://pub.dev/packages/lints
[lint proposal]: https://github.com/dart-lang/lints/issues/new?&labels=type-lint&template=lint-propoposal.md

2
packages/flutter_lints/pubspec.yaml
View File

@ -2,7 +2,7 @@ name: flutter_lints
description: Recommended lints for Flutter apps, packages, and plugins to encourage good coding practices. 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 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 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: environment:
sdk: '>=2.17.0-0 <3.0.0' sdk: '>=2.17.0-0 <3.0.0'