Skip to content

修改config.py成config.py.example 补充README_EN.md丢失docker部署部分 #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

修改config.py成config.py.example 补充README_EN.md丢失docker部署部分 #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git

cd Code-Review-GPT-Gitlab

cp ./config/config.py.example ./config/config.py
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Approve the config copy command and add .gitignore entry.
The cp ./config/config.py.example ./config/config.py step is clear and correct. Please update .gitignore to include config/config.py to prevent accidental commits of sensitive data.

🤖 Prompt for AI Agents 
In README.md at line 182, the command to copy the example config file is
correct. To fix the issue, approve this command as is and then update the
.gitignore file to add an entry for config/config.py. This will prevent the
actual config file from being accidentally committed to the repository,
protecting sensitive data.


vim ./config/config.py

docker run -d --network bridge --add-host=host.docker.internal:host-gateway -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest
Expand All @@ -195,6 +197,7 @@ pip install -r requirements.txt
```
3.**修改配置文件**
```bash
cp ./config/config.py.example ./config/config.py
vim config/config.py
```

Expand Down
16 changes: 16 additions & 0 deletions README_EN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,21 @@ The default supported models are listed in the table below.
# Usage 📖

### install

#### Run by Docker

```bash
git clone git@github.com:mimo-x/Code-Review-GPT-Gitlab.git

cd Code-Review-GPT-Gitlab

cp ./config/config.py.example ./config/config.py

vim ./config/config.py

docker run -d --network bridge --add-host=host.docker.internal:host-gateway -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest
```
Comment on lines +132 to +145
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Approve the new “Run by Docker” section and add .gitignore entry.
The Docker subsection clearly guides users through setup, including copying the example config. Please ensure that config/config.py is listed in .gitignore to keep actual credentials out of version control.

🤖 Prompt for AI Agents 
In README_EN.md around lines 132 to 145, the new "Run by Docker" section is well
written and can be approved as is. To fix the issue, add the path
"config/config.py" to the .gitignore file in the project root to prevent
committing sensitive configuration credentials to version control.


#### Run by Source code
1.**clone repo**
```bash
Expand All @@ -140,6 +155,7 @@ pip install -r requirements.txt
```
3.**modify config file**
```bash
cp ./config/config.py.example ./config/config.py
vim config/config.py
```
4.**run**
Expand Down
0 config/config.py → config/config.py.example
View file
Open in desktop
File renamed without changes.