Guides & How-tos

This section is of short guides and articles is meant to be read alongside the rest of the documentation which is more reference-oriented.

Setting up SQLFluff

• Rolling out SQLFluff with a new team
• Developing Custom Rules

Troubleshooting SQLFluff

• How to Troubleshoot SQLFluff

Contributing to SQLFluff

It is recommended that the following is read in conjunction with exploring the codebase. dialect_ansi.py in particular is helpful to understand the recursive structure of segments and grammars.

You may also need to reference the Internal API.

• Architecture
• How to use Git
• Contributing dialect changes
• Developing Rules
• Developing Plugins
• Documentation Contributions