semantic-release / semantic-release/commit-analyzer
docs: improve documentation of 'config' option
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 448
- Forks
- 82
- Avg merge
- 17h 41m
- Merged PRs (30d)
- 4
Description
https://github.com/semantic-release/commit-analyzer#options
npm package name of a custom conventional-changelog preset.
i.e "conventional-changelog-conventionalcommits"?
- Am I correct in understanding this 'name' would be the same value as used in the following example?
npm install $name - Does the 'config' option require additional configuration like the 'preset' option may require the 'presetConfig' option depending on its value?
- Does it expose options/parameters of the selected config as configurable child objects similar to how options are passed to a plugin?
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 with the linked commit-analyzer options documentation and review the description of the config option against the questions in this issue. Update the documentation to explain the package name, any required configuration, and whether child options are supported; done means each question has an unambiguous answer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 40/100