From ce062adf39d849bc442bebac8279584a2c24b56c Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 13 Jun 2025 20:41:14 +0300 Subject: [PATCH] docs: enhance ticket compliance documentation with new label and configuration options --- .../core-abilities/fetching_ticket_context.md | 37 +++++++++++++++---- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/docs/docs/core-abilities/fetching_ticket_context.md b/docs/docs/core-abilities/fetching_ticket_context.md index 473c5b02..bfb836d9 100644 --- a/docs/docs/core-abilities/fetching_ticket_context.md +++ b/docs/docs/core-abilities/fetching_ticket_context.md @@ -39,17 +39,40 @@ By understanding the reasoning and intent behind modifications, the LLM can offe Similarly to the `describe` tool, the `review` tool will use the ticket content to provide additional context for the code changes. In addition, this feature will evaluate how well a Pull Request (PR) adheres to its original purpose/intent as defined by the associated ticket or issue mentioned in the PR description. -Each ticket will be assigned a label (Compliance/Alignment level), Indicates the degree to which the PR fulfills its original purpose, Options: Fully compliant, Partially compliant or Not compliant. +Each ticket will be assigned a label (Compliance/Alignment level), Indicates the degree to which the PR fulfills its original purpose: + +- Fully Compliant +- Partially Compliant +- Not Compliant +- PR Code Verified ![Ticket Compliance](https://www.qodo.ai/images/pr_agent/ticket_compliance_review.png){width=768} -By default, the tool will automatically validate if the PR complies with the referenced ticket. -If you want to disable this feedback, add the following line to your configuration file: +A `PR Code Verified` label indicates the PR code meets ticket requirements, but requires additional manual testing beyond the code scope. For example - validating UI display across different environments (Mac, Windows, mobile, etc.). -```toml -[pr_reviewer] -require_ticket_analysis_review=false -``` + +#### Configuration options + +- + + By default, the tool will automatically validate if the PR complies with the referenced ticket. + If you want to disable this feedback, add the following line to your configuration file: + + ```toml + [pr_reviewer] + require_ticket_analysis_review=false + ``` + +- + + If you set: + ```toml + [pr_reviewer] + check_pr_additional_content=true + ``` + (default: `false`) + + the `review` tool will also validate that the PR code doesn't contain any additional content that is not related to the ticket. If it does, the PR will be labeled at best as `PR Code Verified`, and the `review` tool will provide a comment with the additional content found in the PR code. ## GitHub Issues Integration