Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Update docs

Aperta
  • Qualcosa non va?
#72 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
elixir
Ambito
documentation, testing

Direzione di ricerca

Esamina la documentazione e gli esempi del repository e leggi l’issue #63 per il contesto di doctest. Il lavoro è completato quando la documentazione è aggiornata, gli esempi eseguibili appropriati sono coperti da doctest e sono presenti typespecs utili dove opportuno; Credo e Dialyzer sono gli strumenti di analisi indicati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

We should make sure:

  • the docs are kept up-to-date
  • examples that can be run as unit tests (because they don't have side-effects or require a complex set-up) should be tested with doctest (see #63)
  • typespecs; these aren't checked by the compiler but can be very useful documentation. They are checked by static code analysis tools like credo and dialyzer).
Lingua principale
Elixir
Stelle
17
Fork
3
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di liquidvotingio/api

Tutte le issue di liquidvotingio/api

Issue simili

Altre issue su Elixir

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.