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

DOCS: Create standard for format and structure of top-level project files across AboutCode repos

Abierto
  • ¿Algo no está bien?
#66 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
markdown
Área
documentation

Línea de trabajo

Empieza comparando los archivos de nivel superior enumerados en dejacode, purldb, scancode.io, scancode-toolkit y vulnerablecode. El issue nombra objetivos inmediatos: convertir RELEASE.md en dejacode y scancode.io a rST, renombrar los archivos apache-2.0.LICENSE a LICENSE y documentar el estándar para los nuevos repositorios de AboutCode. Se considera terminado cuando la convención de nombres/formato de archivos se haya aplicado o documentado claramente, pero el issue es antiguo y abarca varios repositorios.

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

Descripción

documentation

In most AboutCode repos we have a set of top-level project files including:

  • AUTHORS.rst
  • CHANGELOG.rst
  • CODE_OF_CONDUCT.rst
  • CONTRIBUTING.rst
  • LICENSE
  • NOTICE
  • README.rst
  • RELEASE.md (dejacode and scancode.io)
  • ROADMAP.rst

I looked at dejacode, purldb, scancode.io. scancode-toolkit and vulnerablecode as the primary examples

Although the GitHub norm is for the these files to be in markdown format we are using rST in most cases so the cost/effort to move to markdown does not make sense at this time.

For the LICENSE and NOTICE files we have a mixed bag:

  • dejacode: LICENSE file but no NOTICE (makes sense for AGPL-3.0 vs Apache-2.0)
  • purldb: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE
  • scancode.io: LICENSE and NOTICE files - this should be the pattern for all projects licensed under Apache-2.0)
  • scancode-tookit: NOTICE file plus apache-2.0.LICENSE and cc-by-4.0.LICENSE
  • vulnerablecode: NOTICE file plus apache-2.0.LICENSE and cc-by-sa-4.0.LICENSE

If you have a top-level file named LICENSE GitHub displays the license name in a "tab" at the top of the README. Using LICENSE as the file suffix does not seem to mean anything to GitHub.

The issue here is to standardize the format and structure of these files across repos and document it for new projects/repos. Some immediate action items include:

  • Convert RELEASE.md files to rST for dejacode and scancode.io (this should be easy since these are small chunks of text)
  • Rename apache-2.0.LICENSE files to LICENSE.
Lenguaje dominante
JavaScript
Estrellas
9
Forks
17
Merge medio
7 h 55 min
PR fusionados (30 d)
2

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.

Más de aboutcode-org/www.aboutcode.org

Todos los issues de aboutcode-org/www.aboutcode.org

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.