From 41c48ca5b53e325a93fd870683596bd2803a8237 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 12 Jul 2024 17:07:23 +0300 Subject: [PATCH 1/2] example best practice --- docs/docs/tools/improve.md | 3 ++- docs/docs/tools/review.md | 24 ++++++++++++++++-------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index 809c1890..bbcd6e13 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -102,8 +102,9 @@ This page can contain a list of best practices, coding standards, and guidelines The AI model will use this page as a reference, and in case the PR code violates any of the guidelines, it will suggest improvements accordingly, with a dedicated label: `Organization best practice`. -Example for a `best_practices.md` content can be found [here](https://pr-agent-docs.codium.ai/usage-guide/EXAMPLE_BEST_PRACTICE.md) (adapted from Google's [pyguide](https://google.github.io/styleguide/pyguide.html)). +Example for a `best_practices.md` content can be found [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/docs/usage-guide/EXAMPLE_BEST_PRACTICE.md) (adapted from Google's [pyguide](https://google.github.io/styleguide/pyguide.html)). This file is only an example. Since it is used as a prompt for an AI model, we want to emphasize the following: + - It should be written in a clear and concise manner - If needed, it should give short relevant code snippets as examples - Up to 800 lines are allowed diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index f0a3c057..00a6b148 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -43,15 +43,23 @@ num_code_suggestions = ... - The `pr_commands` lists commands that will be executed automatically when a PR is opened. - The `[pr_reviewer]` section contains the configurations for the `review` tool you want to edit (if any). -### Incremental Mode -Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again. -For invoking the incremental mode, the following command can be used: -``` -/review -i -``` -Note that the incremental mode is only available for GitHub. +[//]: # () +[//]: # (### Incremental Mode) -![incremental review](https://codium.ai/images/pr_agent/incremental_review_2.png){width=512} +[//]: # (Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.) + +[//]: # (For invoking the incremental mode, the following command can be used:) + +[//]: # (```) + +[//]: # (/review -i) + +[//]: # (```) + +[//]: # (Note that the incremental mode is only available for GitHub.) + +[//]: # () +[//]: # (![incremental review](https://codium.ai/images/pr_agent/incremental_review_2.png){width=512}) [//]: # (### PR Reflection) From b2710ec029d2f82276461e3679dfa6811aaa5126 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 12 Jul 2024 17:15:00 +0300 Subject: [PATCH 2/2] example best practice --- docs/docs/overview/pr_agent_pro.md | 32 ++++++++++++++++-------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/docs/overview/pr_agent_pro.md b/docs/docs/overview/pr_agent_pro.md index 4fa69817..58836b81 100644 --- a/docs/docs/overview/pr_agent_pro.md +++ b/docs/docs/overview/pr_agent_pro.md @@ -7,22 +7,24 @@ 3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities. 4. **Additional tools** -- [**Analyze PR components**](./tools/analyze.md/) -- [**Custom Prompt Suggestions**](./tools/custom_prompt.md/) -- [**Tests**](./tools/test.md/) -- [**PR documentation**](./tools/documentation.md/) -- [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/) -- [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/) -- [**CI feedback**](./tools/ci_feedback.md/) + - [**Custom Prompt Suggestions**](./tools/custom_prompt.md/) + - [**Tests**](./tools/test.md/) + - [**PR documentation**](./tools/documentation.md/) + - [**Improve Component**](https://pr-agent-docs.codium.ai/tools/improve_component/) + - [**Similar code search**](https://pr-agent-docs.codium.ai/tools/similar_code/) + - [**CI feedback**](./tools/ci_feedback.md/) + - [**Analyze PR components**](./tools/analyze.md/) + 5. **Additional features** -- [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file) -- [**Interactive triggering**](./usage-guide/automations_and_usage.md/#interactive-triggering) -- [**Apply suggestions**](https://pr-agent-docs.codium.ai/tools/improve/#example-usage) -- [**Advanced usage statistics**](https://www.codium.ai/contact/#/) -- [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance) -- [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page) -- [**Inline file summary**](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary) -- More ... + - [**Global and wiki configuration**](./usage-guide/configuration_options.md/#wiki-configuration-file) + - [**Interactive triggering**](./usage-guide/automations_and_usage.md/#interactive-triggering) + - [**Apply suggestions**](https://pr-agent-docs.codium.ai/tools/improve/#example-usage) + - [**Advanced usage statistics**](https://www.codium.ai/contact/#/) + - [**Incorporating companies' best practices**](https://pr-agent-docs.codium.ai/tools/improve/#best-practices) + - [**SOC2 compliance check**](./tools/review.md/#soc2-ticket-compliance) + - [**Custom labels**](./tools/describe.md/#handle-custom-labels-from-the-repos-labels-page) + - [**Inline file summary**](https://pr-agent-docs.codium.ai/tools/describe/#inline-file-summary) + - More ... 6. **Supporting self-hosted git servers** - PR-Agent Pro can be installed on GitHub Enterprise Server, GitLab, and BitBucket. For more information, see the [installation guide](https://pr-agent-docs.codium.ai/installation/pr_agent_pro/). \ No newline at end of file