Improve Clarity and Consistency in Style Guide
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 38/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Ambito
- documentation
Direzione di ricerca
Individua la guida di stile del repository e rivedi le sezioni su em dash, virgola di Oxford, numerali, titoli, sottotitoli ed elenchi puntati descritte nell’issue. Il lavoro è completato quando le linee guida e gli esempi sono coerenti, la formulazione relativa ai numerali è più chiara e la formattazione è uniforme in tutto il documento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 1.5k
- Fork
- 533
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di base/brand-kit
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Add a quick-start section for engineers (formats, preferred files, and usage tips)Forse già presa @faisalnugroho l’ha presa 139 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
шефAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 15/100
Tutte le issue di base/brand-kit
Issue simili
-
documentation glm5 llm-model
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
vllm-project/vllm-ascend#19062 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
tursodatabase/turso#10052 ·
I maintainer di solito rispondono entro 1 giorno
-
Mac mini M6 (16 GB): Q2_0 streaming works - measured 11.7->27.2 tok/s + arena fix for sub-32 GB MacsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
elastic/docs-builder#4495 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
cellrishi-code/claude-skills-atlas#165 ·
I maintainer di solito rispondono entro 1 giorno