Expose short descriptions for CSS properties in mdn/data
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript
Línea de trabajo
Comienza con el documento wiki de descripciones breves de propiedades CSS, issue 261 y el archivo properties.json descrito en este issue. Revisa cómo se recuperan las páginas de MDN mediante el parámetro $json y cómo deben sanitizarse y comprobarse la longitud de los resúmenes. La tarea está terminada cuando se comprueban las descripciones de las propiedades CSS y un script produce una PR de cambios para las diferencias en shortDescription.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
This is to address https://github.com/mdn/data/issues/199 for CSS properties.
The overall proposal for how we are going to do this is captured in the CSS property short descriptions Wiki document.
Broadly there are two aspects to the work: (1) fixing up the content and then (2) getting it into mdn/data:
Check/fix the content
Create and test sample short descriptions
(Issue https://github.com/mdn/data/issues/261)
Write short descriptions for a small number (10) of CSS properties, and test how they would work in the different contexts they might appear in (an MDN page, an editor popup, a devtools widget).
On the basis of these samples:
- draft some guidelines about how the short descriptions should be written
- refine the estimates of how long it will take to update all of them.
Update short descriptions for all CSS properties
Go through all the CSS property pages, checking that the summary is what we want: meaning, it's explicitly marked using "seoSummary", and contains the right content.
Write a script to expose short descriptions in mdn/data
Write a script that works something like this:
-
For each entry in the properties.json file in mdn/data:
a) Get the corresponding MDN page as a JSON object using the $json parameter (e.g. https://developer.mozilla.org/en-US/docs/Web/CSS/margin$json)
b) From this object, get the summary property, sanitize it to ensure it only contains the allowed elements and check that it's the correct length.
c) If the result is different from the current value of shortDescription in properties.json, then add it to a changelist.
-
Open a PR against mdn/data containing the changelist.
- Lenguaje dominante
- JavaScript
- Estrellas
- 786
- Forks
- 216
- Merge medio
- 22 h 24 min
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una 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.
Más de mdn/data
-
Computed value for CSS animation's animation-timeline componentQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
mdn/data#1096 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Missing CSS gaps dataAbiertoneeds triage
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
Los mantenedores suelen responder en 1 día
-
accepting PR
Dificultad 1/5 Menos de una hora Aptitud para principiantes 55/100
Los mantenedores suelen responder en 1 día
-
idle needs triage
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Los mantenedores suelen responder en 1 día
-
Proposal: Remove IE-only featuresQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abiertoidle
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
mdn/data#837 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
kentcdodds/kcd-skills#32 ·
-
good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
tech-debt
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
enhancement frontend good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Los mantenedores suelen responder en 2 días
-
[推荐] SubtitleMedicAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 65/100