riseproject-dev / riseproject-dev/python-wheels
docs: clean up field usage
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 0
- Forks
- 0
- Merge medio
- 16 h 14 min
- PR fusionados (30 d)
- 952
Descripción
We currently have a mixture of several fields in our package docs. Between historic patterns and new workflows, each package may feature one or more of:
comment- a generic field for providing commentary on a package. This was previously always used to provide a link to a GPL sources tarball if required for a packagewarning- usually used to indicate we've had to skip some sort of test or omit a piece of functionality in a module, due to incompatibility or known issues with riscv64 or our infrastructurepatched- a typically blank field used to signal that the package is built with one or more patches applied during the process
These are all somewhat redundant. I propose two to replace these:
gpl-sources- specify this with one or more links if we have to provide GPL source tarballs as part of the package buildscomment- anything else (notes about patching, skipping tests, etc.) goes here
@justeph @luhenry thoughts?
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Línea de trabajo
El issue no nombra archivos ni pruebas específicos; primero localiza los campos de la documentación de los paquetes que actualmente usan comment, warning y patched. Confirma el esquema de campos propuesto antes de migrar las entradas: usa gpl-sources para los enlaces al código fuente GPL y comment para otras notas; después verifica que no quede ningún uso de los campos antiguos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Activo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100