From 4afe05761d0fb65634649cbf4f348884e10e1368 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 24 Nov 2024 17:22:18 +0200 Subject: [PATCH] docs: add section on best practices for multiple languages in improve.md --- docs/docs/tools/improve.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index fb22b940c..c837c869c 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -245,6 +245,20 @@ enable_global_best_practices = true Then, create a `best_practices.md` wiki file in the root of [global](https://qodo-merge-docs.qodo.ai/usage-guide/configuration_options/#global-configuration-file) configuration repository, `pr-agent-settings`. +##### Best practices for multiple languages +For a git organization working with multiple programming languages, you can maintain a centralized global `best_practices.md` file containing language-specific guidelines. +When reviewing pull requests, Qodo Merge automatically identifies the programming language and applies the relevant best practices from this file. +Structure your `best_practices.md` file using the following format: + +``` +# [Python] +... +# [Java] +... +# [JavaScript] +... +``` + ##### Example results ![best_practice](https://codium.ai/images/pr_agent/org_best_practice.png){width=512}