Ygg01/Linguini

Improve docs

Aberta

#23 aberto em 30 de mai. de 2022

Ver no GitHub
 (1 comentário) (1 reação) (0 responsável)C# (15 forks)auto 404
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (42 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

This is more of a meta issue, so contributors can expand docs and add it.

What docs are needed?

  • API Docs. Easiest to add needed on most public methods
  • How-To. Just a quick cookbook examples how to setup some Linguini in a specific case. No external dependencies needed.
  • Tutorial??. Possibly needed, but Linguini is relatively simple.
  • Onboarding docs for new contributors?? Not sure what people need.

Guia do colaborador

Direção de pesquisa
Revise a documentação existente no repositório, identifique lacunas como documentação de API ou exemplos ausentes, e proponha acréscimos seguindo o estilo do projeto.
Pilha de tecnologia
csharp
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.
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
GitC#
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90