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

Introduce documentation

Aperta
#20 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
swift
Ambito
documentation, mobile-dev

Direzione di ricerca

L’issue non indica file, test o punti di ingresso della documentazione. Inizia esaminando l’API del package e stabilisci se la documentazione generata debba essere ospitata su GitHub o su Swift Package Index. Il lavoro è completato quando l’API e il suo comportamento importante sono documentati in una posizione concordata.

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

Descrizione

Request Statement

This package should provide a convenient way for developers to understand how to use the api. Documentation should also describe important behavior of the package

Solution Brainstorm

Automatically generated documentation could be implemented. Either host it then on Github or https://swiftpackageindex.com/SwiftPackageIndex/SPIManifest/~/documentation/spimanifest

Lingua principale
Swift
Stelle
8
Fork
4
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

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.

Issue simili

Altre issue su Swift

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.