treffynnon / sqlstyle.guide

A consistent code style guide for SQL to ensure legible and maintainable projects

Home Page:https://www.sqlstyle.guide

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Badges for sqlstyle.guide

JaneX8 opened this issue · comments

commented

In order to possibly gain popularity (be found easier) and raise the changes of adoption, I'd suggest to ask the projects you listed under https://github.com/treffynnon/sqlstyle.guide#projects-known-to-be-implementing-the-guide along with other users of this standard to mention sqlstyle.guide using this badge (or a variation of it):

sqlstyle.guide
sqlstyle.guide
sqlstyle.guide

sqlstyle.guide
sqlstyle.guide
sqlstyle.guide

sqlstyle.guide
sqlstyle.guide
sqlstyle.guide

sqlstyle.guide
sqlstyle.guide
sqlstyle.guide

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

I used the generated badge (the first in the list above) also in a recent training I gave for a group of webdevelopers, along with similar badges mentioning PEP, PSR and JS-STANDARD.

Last but not least I'd really like to see (sombody creating) a plug-in, add-on for Atom or Notepad++ or other IDE's to perform sqlstyle.guide-compliance testing. That'd likely help to adopt this standard as well.

Let's be honest, developers like badges

This is a nice idea and one that could certainly be added to the README.md in a how to reference the guide section or something. I am unsure of the level of adoption of the badge that you could expect from those projects.

I like the idea of an editor/IDE linter that conforms to the guide and it would be nice to see a formatter too. I did a little work on this in the past to experiment, but didn't get very far before running out of time to dedicate to it. I did open feature requests/make suggestions of a number of SQL products to add a formatter to their software, but there has been no movement on that front as far as I can see. It would seem likely that there will never be one added.

Would you like to open a pill request for this or shall I just add it in? @calico90

commented

Feel free to add it in.