Improve Clarity and Consistency in Style Guide
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- documentation
Línea de trabajo
Localiza la guía de estilo del repositorio y revisa las secciones sobre em dash, coma de Oxford, numerales, encabezados, subencabezados y viñetas descritas en el issue. Se considera terminado cuando las directrices y los ejemplos sean coherentes, la redacción sobre los numerales sea más clara y el formato sea uniforme en todo el documento.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Description:
There are a few areas in the style guide that could be improved for clarity and consistency. Below are the suggested changes:
1. Spacing Around Em Dashes
- The guide uses em dashes without consistent spacing around them. For example, in the sentence:
- "The length of the text on the first line before the em dash will break to the second line of text."
- Suggestion: Add space around em dashes for improved readability:
- "…will break to the second line — of text."
2. Comma Usage in Lists
- The guide states: "Don’t use the Oxford comma," but also provides an example where it is used.
- Suggestion: Ensure consistency in the use of the Oxford comma throughout the document. Either avoid it entirely, or use it consistently.
3. Clarify Numerals Section
- The section about abbreviating large numbers could benefit from more explicit clarification. For example:
- "Use 'K' for thousands (e.g., 10K for 10,000), 'M' for millions, and 'B' for billions."
- Suggestion: Rewrite to make the usage of these abbreviations more clear.
4. General Formatting Consistency
- Ensure that all formatting (such as headings, subheadings, and bullet points) is consistent across the document for better readability.
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 1.5k
- Forks
- 533
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 base/brand-kit
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Add a quick-start section for engineers (formats, preferred files, and usage tips)Posiblemente ocupada @faisalnugroho la tomó hace 140 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
шефAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 15/100
Todos los issues de base/brand-kit
Issues similares
-
area: design documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
eyalgolan/statecraft-israel#883 ·
Los mantenedores suelen responder en 1 día
-
area:release criticality:p3 documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
registrystack/registry-stack#2085 ·
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 87/100
Los mantenedores suelen responder en 1 día
-
[workshop-sync] workshop/side-quest-17-06-output-injection.md: stale add_comment.cjs line referencesAbiertodocumentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
githubnext/gh-aw-workshop#4679 ·
Los mantenedores suelen responder en 1 día
-
git-workflow task-4
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100