conventional-changelog/commitlint

Docs: parserOpts and headerPattern need detailed docs

Closed

#3.336 aberto em 24 de ago. de 2022

Ver no GitHub
 (9 comments) (3 reactions) (0 assignees)TypeScript (896 forks)batch import
communitydocumentationhelp wanted

Métricas do repositório

Stars
 (15.497 stars)
Métricas de merge de PR
 (Mesclagem média 5d 19h) (65 fundiu PRs em 30d)

Description

We use modified version of conventional commits standard on the project and we start use commitlint.

Today i've found problem with config of commitlint and tried to found any info about how to fix it, i've read docs site https://commitlint.js.org and i totally can't found nothing useful information. This site just list availavle option names and examples, but not explain meaning of each option.

It seems that we need to configure parserOpts object and set headerPattern regular expression to parse our commit message, but commitlint just not provide explaining what is this, how it works and how we can use it for our purposes.

We have to improve docs and add descriptions about this, otherwise this powerful tool just useless for developers, because instead of safe our time, it's just take away our time to explore source code of this tool. Right now this tool looks not reliable.

Could you please tell us how many time you need to improve docs?

Guia do colaborador

Direção de pesquisa
Review the existing documentation at commitlint.js.org and the source code for parserOpts and headerPattern. Examine the conventional commits standard. Provide detailed explanations and examples for each option. Engage with maintainers to clarify scope and expected output.
Pilha de tecnologia
typescript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Aguardando mantenedor
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Basic knowledge of commitlintUnderstanding of commit message parsing
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70