From 7b1194633714958d988da2308a117f31e3514ab5 Mon Sep 17 00:00:00 2001 From: oushu1zhangxiangxuan1 Date: Tue, 10 Oct 2023 15:06:55 +0800 Subject: [PATCH] update CONTRIBUTING.md guideline and requirements --- CONTRIBUTING.md | 4 ++-- requirements/dev-requirements.txt | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f44571ac..172067442 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,11 +10,11 @@ git clone https://github.com//DB-GPT ``` 3. Install the project requirements ``` -pip install -r requirements.txt +pip install -r requirements/dev-requirements.txt ``` 4. Install pre-commit hooks ``` -pre-commit install +pre-commit install --allow-missing-config ``` 5. Create a new branch for your changes using the following command: diff --git a/requirements/dev-requirements.txt b/requirements/dev-requirements.txt index 00865cb52..eb54df339 100644 --- a/requirements/dev-requirements.txt +++ b/requirements/dev-requirements.txt @@ -9,4 +9,6 @@ pytest-mock pytest-recording pytesseract==0.3.10 # python code format -black \ No newline at end of file +black +# for git hooks +pre-commmit \ No newline at end of file