Skip to content
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

Write contributing guide for bevy_lint #157

Open
BD103 opened this issue Oct 21, 2024 · 0 comments
Open

Write contributing guide for bevy_lint #157

BD103 opened this issue Oct 21, 2024 · 0 comments
Labels
A-Linter Related to the linter and custom lints C-Docs An improvement in documentation

Comments

@BD103
Copy link
Member

BD103 commented Oct 21, 2024

Since bevy_cli and bevy_lint are so separate, bevy_lint should have a separate contributing guide targeted specifically for it. It should cover the following topics at least:

  1. Setup (installing toolchain, building and running the linter locally)
  2. Finding lint ideas to work on, what is possible with a linter, and when a lint should not be implemented
  3. Creating a lint (with a template file 📝)
  4. Running and writing UI tests
  5. Tips, tricks, and common patterns
  • Finding specific type method calls
  • Creating suggestions
  • Useful queries
  • Debugging, logging, and getting feedback from the compiler
  • Figuring out what HIR node a lint can be silenced from
  • Finding all types that implement a trait
  • Getting the name of a type
  • What do different LateLintPass methods check
  1. Further resources (link to Clippy's documentation, rustc's developer guide, etc.)

I started this in #152, specifically in the bevy_lint/docs folder. Free free to start from there!

@BD103 BD103 added A-Linter Related to the linter and custom lints C-Docs An improvement in documentation labels Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Linter Related to the linter and custom lints C-Docs An improvement in documentation
Projects
None yet
Development

No branches or pull requests

1 participant