private-gpt icon indicating copy to clipboard operation
private-gpt copied to clipboard

Make scripts executable, add basic pre-commit setup

Open mdeweerd opened this issue 2 years ago • 2 comments

Changes to execute ingest.py and privateGPT.py without needing to manually add python3 for executing them.

Also added a "minimal" pre-commit configuration that will not make major changes to the files - for now it removed some spaces at the end of the lines. It also checks spelling, yaml format (useful for the docker configuration that is prepared in another PR).

mdeweerd avatar May 18 '23 00:05 mdeweerd

Should we include pre-commit in requirements and update the Readme to explain how to use it (run pre-commit install)?

imartinez avatar May 18 '23 21:05 imartinez

When it's mentionned, it's mentionned in a file such as "CONTRIBUTING.md" (example).

I can add such a file with an instruction just for that.

mdeweerd avatar May 18 '23 22:05 mdeweerd

When it's mentionned, it's mentionned in a file such as "CONTRIBUTING.md" (example).

I can add such a file with an instruction just for that.

We can leave it for the near future. We could be creating a section on how to contribute.

imartinez avatar May 20 '23 08:05 imartinez