Skip to content

Commit

Permalink
docs: add section on customizing best practices label in improve.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mrT23 committed Nov 24, 2024
1 parent 4afe057 commit 6871e1b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/docs/tools/improve.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,18 @@ Structure your `best_practices.md` file using the following format:
...
```

##### Dedicated label for best practices suggestions
Best practice suggestions are labeled as `Organization best practice` by default.
To customize this label, modify it in your configuration file:

```toml
[best_practices]
organization_name = ""
```

And the label will be: `{organization_name} best practice`.


##### Example results

![best_practice](https://codium.ai/images/pr_agent/org_best_practice.png){width=512}
Expand Down

0 comments on commit 6871e1b

Please sign in to comment.