Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

docs: improve documentation of 'config' option

Aberta
#262 0 comentários 1 reação 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
40/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
javascript
Domínio
documentation

Direção de pesquisa

Comece pela documentação vinculada das opções de commit-analyzer e revise a descrição da opção config em relação às perguntas desta issue. Atualize a documentação para explicar o nome do pacote, qualquer configuração necessária e se opções filhas são compatíveis; considera-se concluído quando cada pergunta tiver uma resposta inequívoca.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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?
Linguagem predominante
JavaScript
Estrelas
446
Forks
82
Merge médio
7h 53min
PRs com merge (30d)
9

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de semantic-release/commit-analyzer

Todas as issues de semantic-release/commit-analyzer

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.