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

Writing documentation on utils

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go
Ambito
documentation

Direzione di ricerca

Inizia elencando i file nella directory /utils e leggendo le funzioni esportate di ogni helper e gli utilizzi esistenti altrove nel repository. Crea un file Markdown accanto a ogni file di utilità con una spiegazione e un piccolo snippet di utilizzo. Il lavoro è completato quando ogni file in /utils ha una documentazione corrispondente che descrive cosa fa e come utilizzarlo.

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

Descrizione

Good First Issue Help Wanted L1 Type: Documentation

Overview

Based on requests of some members of the API team, we will write documentation on how to use helper functions in the /utils directory.

  • Create a .md file for each file within the directory and add the explanation of what it does as well as a small snippet of code on how to use it.
  • You can get a piece of code from the other parts of repo that uses the helper or your own piece of code.
  • For example,
├── logger.go
├── methods.go
├── regexes.go
└── utils_test.go

becomes

├── logger.go
├── logger.md
├── methods.go
├── methods.md
├── regexes.go
├── regexes.md
├── utils_test.go
└── utils_test.md

Note

This is especially important because as the team moves forward and develops more tools and features in the future, we need to utilize these helper more.

Lingua principale
Go
Stelle
12
Fork
54
Merge medio
2m
PR unite (30g)
1

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna 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.

Altre issue di UTDNebula/api-tools

Tutte le issue di UTDNebula/api-tools

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.