Skip to content

Enforce strict multi-line Markdown format for AI-generated issue descriptions #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomas-vilte merged 1 commit into from
Jul 29, 2026
Merged

Enforce strict multi-line Markdown format for AI-generated issue descriptions #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internal/ai/gemini/issue_content_generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ func getIssueSchema() *genai.Schema {
},
"description": {
Type: genai.TypeString,
Description: "The body of the issue in markdown format",
Description: "The body of the issue written as an actual multi-line Markdown document, with real line breaks between headers and paragraphs — like a person typing in a text editor, not a single run-on line. Never write the two-character escape sequence (backslash followed by n) as literal text in place of a line break, and never collapse sections into a single line of prose.",
},
"labels": {
Type: genai.TypeArray,
Expand Down
2 changes: 2 additions & 0 deletions internal/ai/prompts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,7 @@ const (
3. **Accurate Categorization:** Always choose at least one primary category: 'feature', 'fix', or 'refactor'. Use 'fix' ONLY for bug corrections. Use 'refactor' for code improvements without logic changes. Use 'feature' for new functionality.
4. **No Emojis:** Do not use emojis in the title or description. Keep it purely textual and professional.
5. **Balanced Labeling:** Aim for 2-4 relevant labels. Ensure you include the primary category plus any relevant file-based labels like 'test', 'docs', or 'infra' if applicable.
6. **Markdown Format (STRICT):** Write the "description" field as an actual multi-line Markdown document — press enter between lines like a real document, do NOT type the two-character escape sequence (backslash followed by the letter n) as literal text anywhere in the body. Each "### Header" goes on its own line followed by a blank line before the paragraph under it. NEVER collapse multiple sections into a single run-on paragraph.

Generate the issue now.`

Expand All @@ -690,6 +691,7 @@ const (
3. **Categorización Precisa:** Elegí siempre al menos una categoría principal: 'feature', 'fix', o 'refactor'. Solo usá 'fix' si ves una corrección de un bug. Usá 'refactor' para mejoras de código sin cambios lógicos. Usá 'feature' para funcionalidades nuevas.
4. **Cero Emojis:** No uses emojis ni en el título ni en el cuerpo del issue. Mantené un estilo sobrio y técnico.
5. **Etiquetado Equilibrado:** Buscá entre 2 y 4 etiquetas relevantes. Asegurate de incluir la categoría principal más cualquier etiqueta de tipo de archivo como 'test', 'docs', o 'infra' si corresponde.
6. **Formato Markdown (ESTRICTO):** Escribí el campo "description" como un documento Markdown real de varias líneas — apretá enter entre líneas como en un documento de verdad, NO escribas la secuencia de escape de dos caracteres (barra invertida seguida de la letra n) como texto literal en ningún lugar del body. Cada "### Encabezado" va en su propia línea seguido de una línea en blanco antes del párrafo. NUNCA mezcles varias secciones en un solo párrafo de texto corrido.

Generá el issue ahora. Responde en ESPAÑOL.`

Expand Down
Loading