Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Writing documentation on utils

Abierto
  • ¿Algo no está bien?
#120 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go
Área
documentation

Línea de trabajo

Empieza enumerando los archivos del directorio /utils y leyendo las funciones exportadas de cada helper y sus usos existentes en otras partes del repositorio. Crea un archivo Markdown junto a cada archivo de utilidad, con una explicación y un pequeño fragmento de uso. La tarea estará terminada cuando todos los archivos de /utils tengan documentación correspondiente que cubra qué hacen y cómo utilizarlos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Go
Estrellas
12
Forks
54
Merge medio
2 min
PR fusionados (30 d)
1

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de UTDNebula/api-tools

Todos los issues de UTDNebula/api-tools

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.