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

Replace placeholder text in `README.md` — license, maintainers, and duplicated heading

Abierto Apto para principiantes
  • ¿Algo no está bien?
#175 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown
Área
documentation

Línea de trabajo

Empieza en README.md: el encabezado duplicado ## Operational notes está alrededor de las líneas 254-256, el marcador de la licencia alrededor de la línea 279, el marcador de los mantenedores alrededor de las líneas 281-283 y la URL de clonado alrededor de la línea 99. Copia el texto de Apache-2.0 desde el archivo LICENSE de la raíz en lugar de volver a escribirlo, y deja los nombres de los mantenedores como TODO a menos que un mantenedor los proporcione. Corrige el mojibake en CONTRIBUTING.md (línea 3) y en ROADMAP.md, y luego busca el carácter de reemplazo en los tres archivos. Está terminado cuando la lista de verificación de aceptación del issue se cumple y los archivos se guardan en UTF-8.

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

Descripción

documentation good first issue

Problem

README.md contains leftover template scaffolding:

  1. Duplicated heading (lines 254-256):

    ## Operational notes

## Operational notes

    The heading appears twice back to back.

  2. Empty license section (line 279):

    ## License

Specify the project license here.

    A LICENSE file exists at the repo root and package.json declares "license": "Apache-2.0", so the correct text is known — it just was not filled in.

  3. Empty maintainers section (lines 281-283):

    ## Maintainers

- (Add maintainers here)

  4. Stale install URL (line 99): git clone https://github.com/alian-structure/alian-structure-api.git — but the repository lives at github.com/SourceXXL/alian_structure-api. A clone following the README will 404 for anyone without the org.

Also worth noting: CONTRIBUTING.md line 3 and ROADMAP.md both contain mojibake — a corrupted multi-byte character renders as �?. These are almost certainly UTF-8 read as another encoding and should be repaired.

Why it matters

The README is the first thing every contributor and every evaluator reads. A file that says "Specify the project license here" undermines the claim that the project is Apache-2.0 licensed, and a clone URL that 404s is a genuine first-run blocker. The mojibake suggests at least one commit wrote non-UTF-8 content, which can recur.

Suggested Direction

Straightforward edits to README.md:

  1. Delete the duplicate ## Operational notes heading at line 256.
  2. Replace line 279 with the standard Apache-2.0 notice, matching the LICENSE file at the repo root.
  3. Fill in the maintainers section with real names/handles — ask a maintainer rather than guessing.
  4. Fix the clone URL to the actual repository location.
  5. Repair the mojibake in README.md, CONTRIBUTING.md and ROADMAP.md, saving as UTF-8.

Consider adding an editorconfig (.editorconfig with charset = utf-8) to stop this recurring.

Constraints

  • Do not invent maintainer names or contact addresses — leave a placeholder comment if a maintainer has not supplied them.
  • Do not restate the Apache-2.0 text from memory; copy it from the existing LICENSE file so they cannot diverge.

Acceptance Criteria

  • ## Operational notes appears exactly once.
  • The License section matches the LICENSE file.
  • The maintainers section is filled in, or explicitly marked as TODO by a maintainer.
  • The clone URL resolves to a real repository.
  • No mojibake remains in README.md, CONTRIBUTING.md or ROADMAP.md.
  • All files saved as UTF-8; optionally add .editorconfig with charset = utf-8.
Lenguaje dominante
TypeScript
Estrellas
7
Forks
55
Merge medio
1 d 17 h
PR fusionados (30 d)
5

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 SourceXXL/alian_structure-api

Todos los issues de SourceXXL/alian_structure-api

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.