About

Thank you for your interest in contributing to bevy_lint! Please feel free to take a peek at any of the articles in the table of context. These docs follow the Diátaxis documentation system¹, meaning pages are organized based on how they're meant to be read.

• Tutorial: Practice by doing something.
• How-to Guides: Learn how to solve a specific problem.
• Reference: Refer to technical knowledge while working.
• Explanation: Learn the reasons behind certain decisions.

Important

This is the documentation for contributing to bevy_lint. If you want to learn how to use bevy_lint instead, please take a look at the user guide.

Additional Resources

⭐️ = Recommended Reading

• Rust Compiler Development Guide
  • Debugging the compiler (not all sections apply)
  • Overview of the compiler
  • Queries: demand-driven compilation
  • Memory Management in Rustc
  • ⭐️ The HIR
  • rustc_driver and rustc_interface
  • ⭐️ Errors and Lints
  • ⭐️ The ty module: representing types
  • Glossary
  • Code Index
  • Humor in Rust (not actually relevant)
• rustc API Docs
  • ⭐️ clippy_utils
    • ⭐️ match_type()
    • ⭐️ ty_from_hir_ty()
    • ⭐️ span_lint()
    • ⭐️ snippet()
  • rustc_driver
    • run_compiler()
    • Callbacks
  • rustc_hir
    • ⭐️ DefId
    • LocalDefId
    • HirId
    • ⭐️ Expr
    • Item
    • Path
    • Ty (Not to be confused with rustc_middle::ty::Ty)
  • rustc_span
  • rustc_lint
    • ⭐️ LateLintPass
    • ⭐️ LateContext
  • rustc_lint_defs
  • rustc_middle
    • ⭐️ TyCtxt
    • ⭐️ Ty (Not to be confused with HIR Ty)
• Clippy Development
  • ⭐️ Lint passes
  • ⭐️ Emitting a lint
  • ⭐️ Type Checking
  • ⭐️ Dealing with macros and expansions
  • Common tools for writing lints

1. You may also know Diátaxis as the Divio documentation system. Diátaxis was developed while the author was working at Divio. ↩