PabloRMira / sql_formatter

A Python based SQL formatter
https://pablormira.github.io/sql_formatter/
Apache License 2.0
43 stars 10 forks source link

[MNT] Add .pre-commit-hooks.yaml #159

Closed dougthor42 closed 3 years ago

dougthor42 commented 3 years ago

This adds .pre-commit-hooks.yaml to the root of the repo so that people can use this project without having to install sql_formatter into their own environment (pre-commit will install it into it's internal virtual env).

Eg: lets users do this:

repos:
  - repo: https://github.com/PabloRMira/sql_formatter
    rev: master
    hooks:
    - id: sql_formatter
PabloRMira commented 3 years ago

Looks really cool! Thank you very much for your contribution @dougthor42 !

In order for me to not get conflicts later: Could you please rather edit the nbs/index.ipynb instead of the README directly and then populate the index into the README via make prepush?

The reason is that I use the nbdev framework for the development of this project and otherwise I will get conflicts later

I described the setup in detail under Contributing to the code basis

and the development workflow under Development Workflow

Thanks in advance!

dougthor42 commented 3 years ago

Wow, don't I feel foolish! I didn't read your contributing.md file 😨. Sorry about that...

I'll get things fixed asap.

PabloRMira commented 3 years ago

Thank you very much, @dougthor42 !