Skip to content

Commit

Permalink
docs: add section on best practices for multiple languages in improve.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mrT23 committed Nov 24, 2024
1 parent 6240de3 commit 4afe057
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/docs/tools/improve.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit 4afe057

Please sign in to comment.