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

Example Usage Templates

Abierto
#102 2 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
30/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
github-actions, typescript
Área
ci-cd, tooling

Línea de trabajo

Empieza revisando cómo la action genera y sobrescribe actualmente la sección Example Usage, y compara después ese comportamiento con la convención de NOTES.md mencionada en el issue. Define cómo se descubriría y aplicaría un archivo EXAMPLES.json, y considera el ejemplo proporcionado de optionSets como la forma de entrada esperada; se considera terminado cuando el uso de ejemplo proporcionado por el usuario se conserva o se usa como plantilla en lugar de sobrescribirse.

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

Descripción

enhancement

Wanted to get some thoughts about maybe adding templates for the Example Usage section, similar to the use of NOTES.md. As it stands now, this action overwrites the Example Usage section each time it runs, which is less than ideal.

I was thinking maybe an EXAMPLES.json file like the following:

{
    "optionSets": [
        {
            "optionOne": "valueOne"
        },
        {
            "optionTwo": "valueTwo"
        }
    ]
}

If this seems agreeable, I could cook up a PR for this, I think.

Lenguaje dominante
TypeScript
Estrellas
89
Forks
33
Merge medio
3 h 8 min
PR fusionados (30 d)
1

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Sin Dockerfile ni 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 devcontainers/action

Todos los issues de devcontainers/action

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.