From 6871e1b27a6f1606ca8cbd1408fc0a569d73a4ce Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 24 Nov 2024 17:37:35 +0200 Subject: [PATCH] docs: add section on customizing best practices label in improve.md --- docs/docs/tools/improve.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index c837c869c..21af7d6d6 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -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}