Skip to content

Commit

Permalink
Document how to suggest lints for flutter_lints (#1546)
Browse files Browse the repository at this point in the history
  • Loading branch information
goderbauer authored Apr 19, 2022
1 parent b7cd2f4 commit 8e3ce4f
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 1 deletion.
4 changes: 4 additions & 0 deletions packages/flutter_lints/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 2.0.1

* Updated readme to document suggestion process for new lints

## 2.0.0

* Added the following lints:
Expand Down
14 changes: 14 additions & 0 deletions packages/flutter_lints/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/flutter_lints/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit 8e3ce4f

Please sign in to comment.