Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 32 additions & 5 deletions docs/docs/core-abilities/fetching_ticket_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,27 +54,54 @@ A `PR Code Verified` label indicates the PR code meets ticket requirements, but

#### Configuration options

-
-

By default, the tool will automatically validate if the PR complies with the referenced ticket.
By default, the `review` 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 unrelated content found in the PR code.

### Compliance tool

The `compliance` tool also uses ticket context to validate that PR changes fulfill the requirements specified in linked tickets.

#### Configuration options

-

By default, the `compliance` tool will automatically validate if the PR complies with the referenced ticket.
If you want to disable ticket compliance checking in the compliance tool, add the following line to your configuration file:

```toml
[pr_compliance]
require_ticket_analysis_review=false
```

-

If you set:
```toml
[pr_compliance]
check_pr_additional_content=true
```
(default: `false`)

the `compliance` tool will also validate that the PR code doesn't contain any additional content that is not related to the ticket.

## GitHub/Gitlab Issues Integration

Qodo Merge will automatically recognize GitHub/Gitlab issues mentioned in the PR description and fetch the issue content.
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/tools/compliance.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,10 @@ enable_global_pr_compliance = true
???+ example "Ticket compliance options"

<table>
<tr>
<td><b>require_ticket_analysis_review</b></td>
<td>If set to true, the tool will fetch and analyze ticket context for compliance validation. Default is true.</td>
</tr>
<tr>
<td><b>enable_ticket_labels</b></td>
<td>If set to true, the tool will add ticket compliance labels to the PR. Default is false.</td>
Expand Down