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

Roadmap

Abierto
  • ¿Algo no está bien?
#16 0 comentarios 0 reacciones 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
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown, r, yaml
Área
documentation

Línea de trabajo

Start with the _pkgdown.yml roadmap configuration described in the issue and compare the linked stan-dev/loo pull request 396. Trace how this pkg currently handles website templates and how an Rmd document could be integrated without emitting HTML. Done means an opt-in roadmap supports milestone and issue overrides, exclusions, ordering, and closed-issue marking.

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

Descripción

Add a roadmap template like @florence-bockting did for loo: https://github.com/stan-dev/loo/pull/396

This pkg should read a roadmap section in _pkgdown.yml and support overrides per issue for custom descriptions, same for milestones.

Internally the cleanest way of doing this might be to build a custom Rmd which is styled automatically and to wire in some custom classes as needed from Florence's PR. That way actual rendering is purely pkgdown's purview. That is, this pkg shouldn't emit HTML.

Example template:

roadmap:
  enabled: true
  format: "rmd" # in the future support writing a "qmd"

  overrides:
    milestones:
     # milestone numbers, not their titles, for stable IDs.
      "1":
        title: "Version 3.0"
        description: >
          Custom release-level prose.

    issues:
     # similarly, issue numbers for stable ID
      "123":
        description: >
          Custom issue-level prose.

  exclude:
    labels:
      - "internal*"
      - "wontfix"
      - "invalid"
    issues:
      - "124"
      - "456"

This would require pkgs to opt-in, would exclude all PRs, exclude closed milestones, and exclude issues with those labels. Closed issues (which aren't filtered out) in an open milestone should be marked and maybe moved to the end, but otherwise included. Issues will be ordered by issue number.

This would be the default, defined in this pkg, and downstream pkgs could, of course, override as needed. All a typical Stan package would need to get the roadmap is:

roadmap:
  enabled: true

Of course, they would have to use milestones/labels as well, but the website part would be handled by this pkg.

Lenguaje dominante
HTML
Estrellas
0
Forks
0
Merge medio
21 h 23 min
PR fusionados (30 d)
4

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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.

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.