derhuerst/svg-radar-chart

Add JSDoc or types to the project for better documentation

Open

#22 aberto em 21 de mai. de 2024

Ver no GitHub
 (1 comment) (0 reactions) (1 assignee)JavaScript (13 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (93 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Hey mate, thanks for your work

Would it be possible to add JSDoc to the exposed methods of your project so that we can benefit from types? Or export a ts file for typescript users?

Guia do colaborador

Direção de pesquisa
Identifique todas as funções exportadas nos arquivos de origem e adicione comentários JSDoc com anotações de parâmetros e tipo de retorno. Opcionalmente, considere criar um arquivo de definição TypeScript.
Pilha de tecnologia
javascript
Domain
frontenddocumentation
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaScriptGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75