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

[workshop-sync] side-quest-21-01-sub-agent-syntax.md: incorrect claim that unsupported sub-agent fields are stripped with a warning

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#4,132 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go
Área
documentation

Línea de trabajo

Comienza con workshop/side-quest-21-01-sub-agent-syntax.md, luego compara sus afirmaciones con pkg/parser/sub_agent_extractor.go y las pruebas de validación de sub-agent mencionadas. Actualiza la explicación y el checkpoint incorrectos para que coincidan con el comportamiento del parser, y confirma que el ejercicio ya no enseña a los alumnos a evitar una advertencia que no se produce.

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

Descripción

documentation

Workshop file reviewed

workshop/side-quest-21-01-sub-agent-syntax.md

Problem

The file states, regarding sub-agent frontmatter:

Any fields other than description and model are stripped from sub-agent frontmatter at runtime with a warning.

And later, as a checkpoint item:

  • I did not see warnings about stripped sub-agent fields in that run

This is incorrect. The exercise itself asks learners to remove engine: openai from the sub-agent block as if it would otherwise cause a stripped-field warning, but the actual compiler does not strip or warn about extra fields at all.

Current correct syntax

Per pkg/parser/sub_agent_extractor.go in github/gh-aw:

Sub-agent frontmatter keys and their order are preserved without filtering; boundary whitespace is trimmed.

And ValidateInlineSubAgentsFrontmatter is explicitly "best-effort" and only warns on frontmatter parse errors (e.g. unterminated YAML strings) or duplicate agent names — never on unsupported/arbitrary fields. Unit tests (sub_agent_validation_test.go) confirm this: TestValidateInlineSubAgentsFrontmatter_ArbitraryFields and _PreservedFields explicitly include engine: copilot and other arbitrary fields in a sub-agent block and assert assert.Empty(t, warnings, ...).

The official Inline Sub-Agents reference only lists model and description as documented frontmatter fields, but does not state that other fields are stripped or produce a warning — they are simply preserved/ignored by the compiler without validation.

Suggested fix

Remove or rephrase the "stripped... with a warning" claim and the related checkpoint item. Instead, state that only description and model are documented/supported sub-agent fields, and that other fields (like engine) are not validated or used by the runtime, but will not produce a compiler warning. Consider reframing the exercise's "fix" step around correctness/clarity rather than avoiding a warning that does not actually occur.

Generated by 🔍 Workshop Sync Check · copilot · auto · 87.5 AIC · ⌖ 5.89 AIC · ⊞ 9.2K · ◷

  • expires on Oct 4, 2026, 4:53 AM UTC
Lenguaje dominante
JavaScript
Estrellas
55
Forks
36
Merge medio
2 d 8 h
PR fusionados (30 d)
17

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 githubnext/gh-aw-workshop

Todos los issues de githubnext/gh-aw-workshop

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.