github-actions[bot]
commented
9 months ago PR Description updated to latest commit (https://github.com/leonardocustodio/polkadart/commit/25df2c318f2121f201ff03111eced81b60f15506)
Closed justkawal closed 9 months ago
github-actions[bot]
commented
9 months ago PR Description updated to latest commit (https://github.com/leonardocustodio/polkadart/commit/25df2c318f2121f201ff03111eced81b60f15506)
github-actions[bot]
commented
9 months ago | ⏱️ Estimated effort to review [1-5] | 1, because the PR involves a straightforward version downgrade across multiple `pubspec.yaml` files without altering the logic or structure of the code. The changes are repetitive and consistent across all modified files. |
| 🧪 Relevant tests | No |
| 🔍 Possible issues | No |
| 🔒 Security concerns | No |
Utilizing extra instructionsThe `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: ``` [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
How to enable\disable automation- When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the `review` tool is: ``` pr_commands = ["/review", ...] ``` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations |
Auto-labelsThe `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag) - a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) |
Extra sub-toolsThe `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_ticket`, and more. |
Auto-approve PRsBy invoking: ``` /review auto_approve ``` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: ``` [pr_reviewer] enable_auto_approval = true ``` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: ``` [pr_reviewer] maximal_review_effort = 5 ``` |
More PR-Agent commands> To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \ |
github-actions[bot]
commented
9 months ago | Category | Suggestions |
| Best practice |
Specify an exact version for the
___
**Consider specifying the exact version of |
Ensure team awareness of the
___
**Verify that all developers are aware of the | |
| Maintainability |
Assess the impact of downgrading
___
**Evaluate if the downgrade of |
Perform a full project linting after downgrading
___
**After downgrading | |
| Ci/cd |
Review the impact of
___
**Consider the impact of the |
Enabling\disabling automationWhen you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the improve tool is: ``` pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] ``` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically. |
Utilizing extra instructionsExtra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: ``` [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
A note on code suggestions quality- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. - Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode. |
More PR-Agent commands> To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \ |
codecov[bot]
commented
9 months ago All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 48.52%. Comparing base (
8de16ca) to head (25df2c3). Report is 1 commits behind head on main.
Type
enhancement
Description
lintspackage version from^3.0.0to^2.0.0across multiple packages to address CI/CD failures.examples,polkadart,polkadart_cli,polkadart_keyring,polkadart_scale_codec,secp256k1_ecdsa,sr25519,ss58,substrate_bip39, andsubstrate_metadatapackages.Changes walkthrough
10 files
pubspec.yaml
Downgrade lints package version in examplesexamples/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in polkadartpackages/polkadart/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in polkadart_clipackages/polkadart_cli/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in polkadart_keyringpackages/polkadart_keyring/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in polkadart_scale_codecpackages/polkadart_scale_codec/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in secp256k1_ecdsapackages/secp256k1_ecdsa/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in sr25519packages/sr25519/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in ss58packages/ss58/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in substrate_bip39packages/substrate_bip39/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.
pubspec.yaml
Downgrade lints package version in substrate_metadatapackages/substrate_metadata/pubspec.yaml - Downgrade `lints` package from `^3.0.0` to `^2.0.0`.