mono/Embeddinator-4000

[general] Improve docs, showcase and contributing section

Open

#160 aberto em 22 de abr. de 2017

Ver no GitHub
 (2 comments) (0 reactions) (1 assignee)C# (91 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (758 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Currently the github page of Embeddinator is lacking detailed information about how it works, where it's useful, how to contribute etc. I consider this as very important.

My suggestions is following: Start with adding a wiki which describes in more detail how to use it, add some examples both to the repository and the wiki and at least at a contributing.md .

Guia do colaborador

Direção de pesquisa
Revise a documentação existente e crie uma página wiki com exemplos de uso e um arquivo CONTRIBUTING.md. Siga o estilo existente do projeto e vincule recursos relevantes.
Pilha de tecnologia
csharp
Domain
documentationdevtools
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75