vlang/vsl

docs: expand dist/noise/roots README stubs

Ouverte

#321 ouverte le 14 juil. 2026

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)V (49 forks)auto 404
Hacktoberfestdocumentationgood first issue

Métriques du dépôt

Stars
 (400 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Lisez les stubs README existants et le fichier de référence 'metrics/README.md' pour le style. Ensuite, développez le README de chaque module avec le but, la liste des API publiques, des extraits d'utilisation et des liens. Assurez vous que chacun couvre l'intégralité de l'API publique.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitV
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80