Sqlstyle.guide
A consistent code style guide for SQL to ensure legible and maintainable projects
Install / Use
/learn @treffynnon/Sqlstyle.guideREADME
SQL style guide
General
The guide is written in Markdown and uses Jekyll via
GitHub's Pages facility to render itself upon pushing to the gh-pages
branch.
Sources
The markdown source for the guide can be found in _includes/sqlstyle.guide.md
Installing for local development
There is a Gemfile supplied so you just need to follow the GitHub Pages documentation to install the dependencies.
To then run it locally bundle exec jekyll serve
Translations of the guide
If you would like to translate the guide then please open a pull request or open an issue if you need some help getting it setup.
- Arabic by Aya2403
- German/Deutsch by AStasyK
- French/Français by IdrissaD
- Italian/Italiano by robertopauletto
- Japanese/日本語 by nkurigit
- Korean/한국어 by Dokyeongyun
- Polish/Polski by andre-wojtowicz
- Portuguese (Brazil)/Português (BR) by pmarcus93
- Russian/Русский by denpatin
- Simplified Chinese/简体中文 by wontoncoder
- Spanish/Español by OsvaldoGonzalezPy
- Traditional Chinese/正體中文 by Leon0824
- Turkish/Türkçe by mrfade
- Ukrainian/Українська by yar-lukomsky
- Vietnamese/Tiếng Việt by Vũ Phượng Hoàng
Projects known to be implementing the guide
If your project uses this styleguide and you'd like to be mentioned in this readme then please open a pull request adding it below in alphabetical order with a URL and short description.
You can also add a badge (
) to your projects readme with the following markdown code if you like:
[](https://www.sqlstyle.guide/)
- BEdita - a Symfony based PHP CMF
- SQLQuery.jl - A Julia lang package for representing sql queries, and converting them to valid SQL statements
- Stock Talk - a realtime dashboard that displays the stock data of the most Tweeted Nasdaq companies.
Notable forks of the guide
These are based on, but deviate in some way from sqlstyle.guide.
If you have forked this styleguide and you'd like to be mentioned in this readme then please open a pull request adding it below in alphabetical order with a URL and short description of your deviance.
- Lumos Labs - removed the river, Redshift, etc. www
- Mozilla - removed the river, heavily modified www
- Ricardo.ch
- Scout24
- T-SQL style guide by John McCall
Related Skills
oracle
345.9kBest practices for using the oracle CLI (prompt + file bundling, engines, sessions, and file attachment patterns).
prose
345.9kOpenProse VM skill pack. Activate on any `prose` command, .prose files, or OpenProse mentions; orchestrates multi-agent workflows.
Command Development
106.4kThis skill should be used when the user asks to "create a slash command", "add a command", "write a custom command", "define command arguments", "use command frontmatter", "organize commands", "create command with file references", "interactive command", "use AskUserQuestion in command", or needs guidance on slash command structure, YAML frontmatter fields, dynamic arguments, bash execution in commands, user interaction patterns, or command development best practices for Claude Code.
Plugin Structure
106.4kThis skill should be used when the user asks to "create a plugin", "scaffold a plugin", "understand plugin structure", "organize plugin components", "set up plugin.json", "use ${CLAUDE_PLUGIN_ROOT}", "add commands/agents/skills/hooks", "configure auto-discovery", or needs guidance on plugin directory layout, manifest configuration, component organization, file naming conventions, or Claude Code plugin architecture best practices.
