xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-03 04:10:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

typos

Browse Source
This commit is contained in:
mrT23
2023-09-29 11:53:39 +03:00
parent 902975b660
commit 73cc7c2d71
7 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -34,7 +34,7 @@ See the [Usage Guide](./Usage.md) for instructions how to run the different tool
See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools. See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools.
[Release notes](./RELEASE_NOTES.md) See the [Release notes](./RELEASE_NOTES.md) for updates on the latest changes.
<h3>Example results:</h3> <h3>Example results:</h3>
</div> </div>

2
Usage.md
View File

@ -15,7 +15,7 @@ There are 3 basic ways to invoke CodiumAI PR-Agent:
2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR 2. Online usage - by [commenting](https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901) on a PR
3. Enabling PR-Agent tools to run automatically when a new PR is opened 3. Enabling PR-Agent tools to run automatically when a new PR is opened
See the [installation guide](/INSTALL.md) for instructions on how to setup your own PR-Agent. See the **[installation guide]**(/INSTALL.md) for instructions on how to setup your own PR-Agent.
Specifically, CLI commands can be issued by invoking a pre-built [docker image](/INSTALL.md#running-from-source), or by invoking a [locally cloned repo](INSTALL.md#method-2-run-from-source). Specifically, CLI commands can be issued by invoking a pre-built [docker image](/INSTALL.md#running-from-source), or by invoking a [locally cloned repo](INSTALL.md#method-2-run-from-source).

5
docs/DESCRIBE.md
View File

@ -1,7 +1,7 @@
# Describe Tool # Describe Tool
The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, code walkthrough and labels. The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, code walkthrough and labels.
It can ba invoked manually by commenting on any PR: It can be invoked manually by commenting on any PR:
``` ```
/describe /describe
``` ```
@ -29,9 +29,10 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti
#### Markers template #### Markers template
markers template enable to easily integrate user's content and auto-generated content. markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.
- `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false. - `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false.
For example, if the PR original description was: For example, if the PR original description was:
``` ```
User content... User content...

4
docs/REVIEW.md
View File

@ -1,7 +1,7 @@
# Describe Tool # Describe Tool
The `review` tool scans the PR code changes, and automatically generates a PR review. The `review` tool scans the PR code changes, and automatically generates a PR review.
It can ba invoked manually by commenting on any PR: It can be invoked manually by commenting on any PR:
``` ```
/review /review
``` ```
@ -31,7 +31,7 @@ By invoking:
``` ```
/reflect_and_review /reflect_and_review
``` ```
The module will first ask the author questions about the PR, and will guide the review based on his answers. The tool will first ask the author questions about the PR, and will guide the review based on his answers.
<kbd><img src=./../pics/reflection_questions.png width="768"></kbd> <kbd><img src=./../pics/reflection_questions.png width="768"></kbd>
<kbd><img src=./../pics/reflection_answers.png width="768"></kbd> <kbd><img src=./../pics/reflection_answers.png width="768"></kbd>

2
docs/SIMILAR_ISSUE.md
View File

@ -1,6 +1,6 @@
# Similar Issue Tool # Similar Issue Tool
The similar issue tool retrieves the most similar issues to the current issue. The similar issue tool retrieves the most similar issues to the current issue.
It can ba invoked manually by commenting on any PR: It can be invoked manually by commenting on any PR:
``` ```
/similar_issue /similar_issue
``` ```

4
docs/TOOLS_GUIDE.md
View File

@ -4,4 +4,6 @@
- [IMPROVE](./IMPROVE.md) - [IMPROVE](./IMPROVE.md)
- [ASK](./ASK.md) - [ASK](./ASK.md)
- [SIMILAR_ISSUE](./SIMILAR_ISSUE.md) - [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)
- [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md) - [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)
See the **[installation guide]**(/INSTALL.md) for instructions on how to setup your own PR-Agent.

2
docs/UPDATE_CHANGELOG.md
View File

@ -15,5 +15,5 @@ For example:
Under the section 'pr_update_changelog', the [configuration file](./../pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool: Under the section 'pr_update_changelog', the [configuration file](./../pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool:
- `push_changelog_changes`: whether to push the changes to changelog changes, or just print them. Default is false (print only). - `push_changelog_changes`: whether to push the changes to CHANGELOG.md, or just print them. Default is false (print only).
- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ... - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...