1
0
Fork 0
mirror of https://github.com/treffynnon/sqlstyle.guide.git synced 2025-03-09 12:49:51 -05:00
A consistent code style guide for SQL to ensure legible and maintainable projects
Find a file
2017-02-27 09:55:03 +10:00
_includes Closes #8 by adding examples of GROUP and UNION 2017-02-27 09:55:03 +10:00
_layouts Correct HTML etc 2015-07-13 11:29:31 +01:00
.gitignore gitignore the gemfile lock 2015-07-03 14:23:37 +01:00
_config.yml Change to use the rouge syntax highlighter 2016-09-01 13:06:15 +10:00
CNAME Correct HTML etc 2015-07-13 11:29:31 +01:00
Gemfile Add dependency management 2015-07-03 14:22:17 +01:00
index.md Add in a TOC 2015-07-07 09:45:27 +01:00
LICENCE Update the licence file with the correct contact details 2016-12-13 12:02:46 +10:00
README.md Add two new projects to known implementers 2016-10-13 15:05:27 +10:00
scripts.js Add some more ancillilary info 2015-07-13 11:48:15 +01:00
style.css Eradicate mobile bug 2015-07-13 12:14:17 +01:00

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

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.

  • 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.