commitizen / commitizen/cz-conventional-changelog

Documentation for `config.commitizen` settings and custom configuration file support

Open
#222 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
793
Forks
444
PR merge metrics
No merged PRs in 30d

Description

Hi,

I am having difficulty finding documentation for the settings available under `config.commitizen` for `cz-conventional-changelog`.

The official documentation states:

> "Like Commitizen, you specify the configuration of `cz-conventional-changelog` through the package.json's `config.commitizen` key."

However, I have not been able to find comprehensive documentation for the available settings.

Additionally, I attempted to use a custom configuration file by setting up the following in my `package.json`:

```json
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog",
"config": "./.cz-config.mjs"
}
}
```

In `.cz-config.mjs`, I have custom settings, but it does not seem to work as expected. Here is a sample of my `.cz-config.mjs`:

```javascript
export default {
types: [
{ value: 'feat', name: 'feat: A new feature' },
{ value: 'fix', name: 'fix: A bug fix' },
{ value: 'docs', name: 'docs: Documentation only changes' },
// other types
],
scopes: [
{ name: 'module1' },
{ name: 'module2' },
{ name: 'module3' }
],
// other settings
};
```

Can you please provide detailed documentation for the available settings under `config.commitizen` and clarify if custom configuration files like `.cz-config.mjs` are supported?

Thank you!

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the official documentation and the package.json configuration shown in the issue, then inspect how the adapter handles the config.commitizen and .cz-config.mjs settings. Document the available settings and clearly state whether custom configuration files are supported, including the expected configuration format.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.