semantic-release / semantic-release/commit-analyzer
docs: improve documentation of 'presetConfig' option
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 448
- Forks
- 82
- Avg merge
- 17h 41m
- Merged PRs (30d)
- 4
Description
- 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, thepresetConfigoption 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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for the presetConfig option and inspect how presets are defined or referenced in the project. Check the current conventionalcommits behavior and identify which presets require or accept configuration; done means the option's expected types, examples, and preset requirements are documented accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100