Pre-commit hooks and relevant README

lttkgp / C-3PO

The metadata overlord and API server for LTTKGP

https://api.lttkgp.com

MIT License

27 stars 22 forks source link

Pre-commit hooks and relevant README #96

Closed 2000yeshu closed 3 years ago

2000yeshu commented 3 years ago

Added Developing section in README for setting up pre-commit hooks for the local repo.
Added .pre-commit-config.yaml

mukul-mehta commented 3 years ago

I had the same error, seems like it isn't parsing args for isort correctly. There is no space between ./ and the arguments. A simple fix for me was adding a space after ./

- repo: https://github.com/timothycrosley/isort
    rev: 5.0.5
    hooks:
      - id: isort
        files: "./ "
        args: ["--atomic", "--skip migrations"]

2000yeshu commented 3 years ago

That's wierd..It didn't came up before. I'll make that change.

ghostwriternr commented 3 years ago

Also what type of changes are you making to test each type of hook

Some simple changes to manage.py covered several of these hooks. There isn't any need to test the hooks themselves (since the library has done that for us), but rather just to confirm that every hook that we have included runs as expected.