jquery/sizzle

Reorganize docs

Open

#366 aberto em 11 de nov. de 2015

Ver no GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (991 forks)batch import
help wanted

Métricas do repositório

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

Description

README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.

Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.

Guia do colaborador

Direção de pesquisa
Mova a documentação da API do wiki para o README.md, focando no uso. Em seguida, mova as diretrizes de desenvolvimento e contribuição restantes para CONTRIBUTING.md e garanta que o README.md tenha um link para CONTRIBUTING.md.
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.
90