openwisp / openwisp-docs

OpenWISP Documentation.
http://openwisp.io/docs/
BSD 3-Clause "New" or "Revised" License
50 stars 65 forks source link

[developer] Add and explain pre-commit-hook #100

Open nemesifier opened 4 years ago

nemesifier commented 4 years ago

In the past we had runflake8, runisort scripts all over the repos.

Now we don't have any script but I realize we may need to reintroduce a script for each repo because the flags passed to openwisp-qa-checks are slightly different for each repo.

This way we can have a run-qa-checks script for each repo and we can create pre-commit-hooks that run the script before each commit.

We can put the hook in each repo automatically as well as suggested here: https://stackoverflow.com/questions/3462955/putting-git-hooks-into-repository

The hook could be saved in openwisp-utils. Python packages could install it automatically in the setup.py script, eg:

For non python packages we can do something similar as all the repos should have some kind of build/install script/procedure (if they don't have one, we must add one).

priyanshuone6 commented 3 years ago

Is this issue needed as it is related to this https://github.com/openwisp/openwisp-utils/pull/162?

purhan commented 3 years ago

@priyanshuone6 https://github.com/openwisp/openwisp-utils/pull/162 will add a 'pre-push-hook'. But it also will make it easier to install other hooks, so I'd say we should wait till it is merged before working on this. Also I guess we should make that PR more generalized in that case.

praptisharma28 commented 7 months ago

Greetings @nemesifier, is this issue still open to work? I want to work upon it.