diff --git a/docs/config/configuration_file.md b/docs/config/configuration_file.md index 846910255..71944cb71 100644 --- a/docs/config/configuration_file.md +++ b/docs/config/configuration_file.md @@ -20,6 +20,14 @@ Configuration files are typically located in the root of your project directory. The first valid configuration file found will be used. If no configuration file is found, Commitizen will use its default settings. +!!! note + Commitizen supports explicitly specifying a configuration file using the `--config` option, which is useful when the configuration file is not located in the project root directory. + When `--config` is provided, Commitizen will only load configuration from the specified file and will not search for configuration files using the default search order described above. If the specified configuration file does not exist, Commitizen raises the `ConfigFileNotFound` error. If the specified configuration file exists but is empty, Commitizen raises the `ConfigFileIsEmpty` error. + + ```bash + cz --config + ``` + !!! tip For Python projects, it's recommended to add your Commitizen configuration to `pyproject.toml` to keep all project configuration in one place.