Add a checklist of standard tasks to the PR template & CONTRIBUTING.md

Abierto Apto para principiantes
#1,007 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
swift

Línea de trabajo

Empieza por localizar la plantilla de PR existente y CONTRIBUTING.md, y lee ambas de principio a fin para ver el tono actual y la estructura de las secciones. Convierte la lista del issue en elementos de checklist, enlazando Scripts/format.sh, swift test y las fuentes de DocC bajo Sources/ArgumentParser/Documentation.docc donde corresponda. Se considera terminado cuando ambos archivos contienen la misma checklist y un mantenedor puede marcar cada elemento en un PR.

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

Descripción

documentation

A lot of PRs don't seem to have updated various subsystems or files that should also have been updated to correspond with the changes from the PR (see list below).

To avoid oversights, please add a checklist of standard tasks to the PR template & CONTRIBUTING.md (& wherever else is advisable), including subsystems / files that should be updated to correspond with included changes when necessary:

  • Input validation (if / when it is implemented)
  • Help output
  • ToolInfo (including which versions should be updated)
  • Completions
  • Formatting (via Scripts/format.sh)
  • Documentation (under Sources/ArgumentParser/Documentation.docc, maybe with a link to mappings from Swift directories or files to md files)
  • Documentation (DocC in Swift files)
  • Adding / updating tests (maybe with a link to tests that should be updated per Swift directory and/or file)
  • Testing (swift test)
  • Etc.
Lenguaje dominante
Swift
Estrellas
3.8k
Forks
436
Merge medio
4 d 11 h
PR fusionados (30 d)
2

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 apple/swift-argument-parser

Todos los issues de apple/swift-argument-parser

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.