Add a table of contents to the README
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 90/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- markdown, python
- Área
- documentation
Línea de trabajo
El cambio va en README.md en la rama dev: añade una sección ## Contents entre la introducción del proyecto y Installation. Primero lee los encabezados de segundo nivel existentes y enlaza cada uno en su orden actual con enlaces de anclaje de GitHub, como [Installation](#installation). Previsualiza el Markdown renderizado para confirmar que cada enlace lleva a su encabezado, y deja intactos los ejemplos e instrucciones existentes. Está terminado cuando la lista cubre todas las secciones de segundo nivel en orden y el PR apunta a dev.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
What to do
- Create a topic branch from
dev. - Edit README.md.
- Add a
## Contentssection after the project introduction and before Installation. - Link to each existing level-two section, in its current order. For example:
[Installation](#installation)and[Quick Start](#quick-start). - Preview the rendered Markdown and check that each link reaches the matching heading.
- Open a pull request targeting
dev.
Acceptance criteria
- The contents list links to all existing level-two sections, in order, excluding the Contents section itself.
- Each link works in GitHub's rendered README.
- The change only adds navigation to README.md and preserves its existing examples and instructions.
See CONTRIBUTING.md for the repository workflow. This is a documentation-only task, so no implementation regression tests or package-version change are required.
- Lenguaje dominante
- Python
- Estrellas
- 1
- Forks
- 2
- Merge medio
- 7 min
- PR fusionados (30 d)
- 8
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Issues similares
-
area:scripts area:tests bug priority:later
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Ikalus1988/MisakaNet#4358 ·
Los mantenedores suelen responder en 1 día
-
Discovered ports from service discovery are never propagated to modules in Module.load()Posiblemente ocupada @vishalmore90 la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OWASP/Nettacker#1828 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
aws-samples/sample-per-model-bedrock#708 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
[Performance] Bound resolve_api_hashes raw fallback reads to the 1 MiB region actually scannedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
sjkim1127/Reversecore_MCP#365 ·
Los mantenedores suelen responder en 1 día