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

Request: documents should link what they document

Abierto
  • ¿Algo no está bien?
#784 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
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
html
Área
documentation

Línea de trabajo

Comience con la referencia del metamodelo de documentos enlazada en el issue y compárela con el ejemplo del informe de verificación de módulos. Determine cómo debería representarse una relación explícita entre documento y módulo, incluido el nombre de enlace propuesto y el comportamiento del backlink. Se considera terminado cuando el metamodelo admite la relación y el informe puede utilizarla para la trazabilidad.

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

Descripción

My concrete example is the module verification report

Currently the analyzed module can be determined from the id only, or from being in the same repository. While that is theoretically enough for traceability, a more explicit link would help traceability tooling.

Proposal: extend document with a documents or affects or belongs_to links or similar, which would link to the mod in question.

This will also establish a backlink from modules to module verification reports.

Todays workaround is a custom type which has such a link. This allows automated generation of such reports.

Image
Lenguaje dominante
HTML
Estrellas
5
Forks
22
Merge medio
11 h 59 min
PR fusionados (30 d)
25

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 eclipse-score/process_description

Todos los issues de eclipse-score/process_description

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.