vlang/vsl

docs: expand dist/noise/roots README stubs

Aberta

#321 aberto em 14 de jul. de 2026

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)V (49 forks)auto 404
Hacktoberfestdocumentationgood first issue

Métricas do repositório

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

Description

Three modules have minimal READMEs:

  • dist/README.md — 112 bytes
  • noise/README.md — 2 sentences
  • roots/README.md — 1 sentence

Task

Expand each README with:

  1. Module purpose and capabilities
  2. Public API listing with usage snippets
  3. Links to examples and related docs

Use metrics/README.md as reference for the expected quality level.

Verification

  • Each README covers the module's full public API

Guia do colaborador

Direção de pesquisa
Leia os stubs README existentes e o arquivo de referência 'metrics/README.md' para o estilo. Em seguida, expanda o README de cada módulo com propósito, listagem da API pública, trechos de uso e links. Certifique se de que cada um cubra toda a API pública.
Pilha de tecnologia
None
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitV
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80