sinonjs/sinon

"API Specification" Style Documentation

Open

#2.003 aberto em 2 de abr. de 2019

Ver no GitHub
 (14 comments) (1 reaction) (0 assignees)JavaScript (764 forks)batch import
DocumentationHelp wantedNeeds investigationhacktoberfestpinned

Métricas do repositório

Stars
 (9.548 stars)
Métricas de merge de PR
 (Mesclagem média 6d 16h) (15 fundiu PRs em 30d)

Description

I would love to see API Specification style documentation for Sinon, along the lines of what you see in Java (the gold standard of documentation), or jQuery.

An A-Z alphabetical list of functionality, written in a non-conversational way (which is how the current documentation is currently written) is what this documentation needs.

Guia do colaborador

Direção de pesquisa
Veja a estrutura de documentação existente, encontre uma função ainda não documentada no estilo A Z e adicione uma entrada de referência de API concisa seguindo o padrão da documentação Java ou jQuery.
Pilha de tecnologia
javascript
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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80