jerdra/niviz-rater

DOC: Initial documentation

Aberta

#4 aberto em 7 de dez. de 2021

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Python (4 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (2 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

The following documentation components would be good to cover for new users:

Getting started

  1. Tutorial dataset (host images on OSF) + expected dataset structure
  2. YAML specification for constructing views
  3. UI overview (grouping, shortcuts)

Guia do colaborador

Direção de pesquisa
Revise a estrutura atual do repositório e a documentação existente. Explore o aplicativo para entender como as visualizações são configuradas via YAML. Reúna capturas de tela e exemplos para o guia do usuário. Verifique o README para instruções de configuração para executar o aplicativo localmente.
Pilha de tecnologia
python
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80