hugapi/hug

hug needs more documentation

Open

#319 aberto em 25 de mai. de 2016

Ver no GitHub
 (10 comments) (8 reactions) (0 assignees)Python (389 forks)batch import
bugenhancementhelp wanted

Métricas do repositório

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

Description

hug has a collection of documentations on hug.rest and on the github repo (including examples etc) which has served as a reasonable starting point. However, for continued growth, a wider depth of and a higher quality of documentation is an absolute necessity and it is the number 1 priority for the project.

Feel free to add any ideas for additional documentation sources that could be useful for the project to this issue. The currently known ones are:

  • FAQ
  • Known Issues / Gotchas
  • Best Practices
  • Example starting points
  • Full documentation for all exposed APIs and features

I, and the entire community, would be grateful for any help in this area.

Thanks!

~Timothy

Guia do colaborador

Direção de pesquisa
Contribua com a documentação adicionando FAQ, melhores práticas ou pontos de partida de exemplo para o framework de API hug.
Pilha de tecnologia
python
Domain
backend
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.
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
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90