CSSG-Labs/flask-todo-app

Improve CONTRIBUTING.md documentation

Aberta

#32 aberto em 11 de mai. de 2022

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (1 responsável)HTML (4 forks)auto 404
documentationgood first issue

Métricas do repositório

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

Description

What

  • Adds linux and macOS instructions in CONTRIBUTING.md's "Development Environment Setup" section
  • Adds video and screenshots to make the process easier to understand

Why

  • Current document does not provide instructions for linux or macOs
  • Also does not provide enough explanation in the steps
  • Lack of detailed instructions hurts the onboarding process for new members

How

Requirements

  • Improved steps should be clear and descriptive
  • There should be visual elements (screenshots or video)

Guia do colaborador

Direção de pesquisa
Leia o CONTRIBUTING.md atual, consulte o guia de instalação do Flask para Linux e macOS e documente as etapas com capturas de tela e um vídeo.
Pilha de tecnologia
pythonflask
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.
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.
85