search

treffynnon / sqlstyle.guide

A consistent code style guide for SQL to ensure legible and maintainable projects
https://www.sqlstyle.guide
Other
1.37k stars 1.32k forks source link
sql styleguide

readme

SQL style guide

☛ Read the 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.

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 (sqlstyle.guide) to your projects readme with the following markdown code if you like:

[![sqlstyle.guide](https://img.shields.io/badge/style-sqlstyle.guide-brightgreen.svg)](https://www.sqlstyle.guide/)

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.