-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document how to suggest lints for flutter_lints #1546
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just one comment
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you need [lint proposal][]
for that link to work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The style without the []
also works: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links
I also verified that the links further up in the readme using the same style link correctly, see https://pub.dev/packages/flutter_lints/versions/2.0.0.
packages/flutter_lints/README.md
Outdated
## Adding new lints | ||
|
||
Please file a [lint proposal] issue to suggest that an existing lint rule should | ||
be added to this packages. The benefits and risks of adding a lint should be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
=> this package.
packages/flutter_lints/README.md
Outdated
[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/choose |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider going a step past the chooser?
https://github.com/dart-lang/lints/issues/new?&labels=type-lint&template=lint-propoposal.md
Pre-launch Checklist
dart format
.)[shared_preferences]
pubspec.yaml
with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.md
to add a description of the change, following repository CHANGELOG style.///
).If you need help, consider asking for advice on the #hackers-new channel on Discord.