chipsalliance/chisel

Update docs/README.md

Fechada

#4.402 aberto em 16 de set. de 2024

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)Scala (651 forks)batch import
good first issue

Métricas do repositório

Stars
 (4.658 estrelas)
Métricas de merge de PR
 (Mesclagem média 3d 21h) (16 fundiu PRs em 30d)

Description

It's a bit dated, it needs to tell people where to put docs, how to run mdoc and view the result, and how to build the website to see it rendered.

Guia do colaborador

Direção de pesquisa
Atualize o README para incluir instruções sobre onde colocar os arquivos de documentação, como executar o mdoc para verificar e como construir o site para visualização.
Pilha de tecnologia
scala
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.
80