Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve documentation of 'presetConfig' option #263

Open
BinToss opened this issue Sep 12, 2021 · 3 comments
Open

docs: improve documentation of 'presetConfig' option #263

BinToss opened this issue Sep 12, 2021 · 3 comments

Comments

@BinToss
Copy link

BinToss commented Sep 12, 2021

  • What type of object(s) does this option expect? Strings? Arrays? Please provide examples.

Note: For presets that expects a configuration object, such as conventionalcommits, the presetConfig option must be set.

  • Do any other presets require this option?
  • Do any presets not require it, but allow it to be used to configure the preset?

conventional-changelog-conventionalcommits no longer requires the presetConfig to be set. The corresponding parameter is optional these days.

@GorreriFranco
Copy link

Hi! Are there any updates on this?

1 similar comment
@gabriel-henriq
Copy link

Hi! Are there any updates on this?

@kddsultan
Copy link

Even an example would be pretty helpful (instead of looking into the code)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants