ankitaggarwal011/PyCNN

Add contributing guidelines to the project

Open

#14 aberto em 3 de out. de 2016

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Python (86 forks)batch import
documentationeasyhacktoberfesthelp wanted

Métricas do repositório

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

Description

This will make things easier for the contributors.

Some important points to be highlighted in the contributing guide would be:

  • How to contribute - improve documentation/add new methods/improve performance.
  • Explain contribution workflow - issues/pull-request/review.
  • An overview of code structure and API.
  • Coding practices to follow.
  • Guide to add a new image processing method.

Any suggestions are welcome. Thanks.

Guia do colaborador

Direção de pesquisa
Revise a estrutura atual do repositório, identifique áreas chave como organização do código, testes e documentação da API, e então redija as diretrizes de contribuição seguindo as melhores práticas de projetos de código aberto semelhantes.
Pilha de tecnologia
python
Domain
computer visiondocumentation
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
GitGitHub
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90