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

Notable change description text format

Abierto
  • ¿Algo no está bien?
#1,068 5 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
release

Línea de trabajo

Comienza por el comentario vinculado de la issue Release 1063 y la redacción existente del bot notable-change. Compara los marcadores Markdown propuestos con el formato alternativo git-node-release.summary y sigue la automatización de release-summary; el trabajo estará terminado cuando exista un formato acordado y documentado que la automatización pueda extraer de forma coherente para los anuncios de releases y las publicaciones sociales breves.

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

Descripción

Spinning off from https://github.com/nodejs/Release/issues/1063#issuecomment-2539972117 , when the notable-change label is applied, the bot says:

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section.

But it's still not very clear what you are supposed to do - at least my interpretation is that one should just edit the PR description and the release announcement will copy whatever that's in the PR description, but it seems that's rarely the case. In the past notable changes PR I see people do all sorts of random stuff based on their own interpretation of what the bot says, and in the past release announcements I've also seen summaries that didn't match any of the things people did in the PR. There are many notable change PRs with well-formed descriptions which don't get copy pasted into the release announcement, presumably because they don't match some unspecified format to indicate that the descriptions they prepared are the text that are supposed to be copied.

To copy what I discussed with @aduh95 on slack

I wonder if we can devise a standard way for people to denote a block of markdown as text proposed for notable changes, and the the automation can gather them to form the basis of the release announcement and open a PR to the blog automatically while the proposal PR is sent. Maybe a one line short description too, so the automation can collect them and form a Bluesky post, and send a PR to the Bluesky repo, which can be edited a bit there and may or may not have to be sent from the official account (can be sent from releaser’s account first and then the PR is amended into a repost, but at least the text can be collaborated on GitHub)

A proposed format that would be automatable:

<!-- Bullet point content for release micro post: foo.bar -->

<!-- Summary for release announcement starts -->

## Support `foo.bar`

This pull request introduces `foo.bar`, which allows users to do bar with foo.

<!-- Summary for release announcement ends -->

And the automation will replace "This pull request" with "This release" for the text summaries, leading to

  1. In the bluesky post draft generated for the release, it will be something like

    Node.js v1.2.3 is out!

- foo.bar

  2. In the blog post and changelog etc. draft generated, it will just include whatever in that starts/ends block, and replace "This pull request" with "This release", and leave it for people to make the wording look less weird for a release announcement.

If we want to go with the less-human readable but more explicit about what's automated route, or allow multiple summaries in one PR (I imagine this would be generated by something like git node release summary, and I modeled it after what's used by https://github.com/nodejs/node-core-utils/blob/main/docs/ncu-team.md).

<!-- git-node-release.summary.title(fooBar, "foo.bar") -->

<!-- git-node-release.summary.start(fooBar) -->

## Support `foo.bar`

This pull request introduces `foo.bar`, which allows users to do bar with foo.

<!-- git-node-release.summary.end(fooBar) -->

(I am not sure whether this is too cryptic, but anyway just to kick off some discussion about how to actually specify an automatable format instead of continue leaving it open to interpretation).

Lenguaje dominante
JavaScript
Estrellas
4.4k
Forks
675
Sin PR fusionados en 30 d

Preparar el entorno

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 nodejs/Release

Todos los issues de nodejs/Release

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.