Improve Clarity and Consistency in Style Guide
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 38/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
リポジトリのスタイルガイドを見つけ、issue に記載されている em dash、Oxford comma、数詞、見出し、小見出し、箇条書きのセクションを確認してください。ガイダンスと例に一貫性があり、数詞に関する表現がより明確で、ドキュメント全体のフォーマットが統一されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- 言語のデータがありません
- スター
- 1.5k
- フォーク
- 533
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
base/brand-kit のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
Add a quick-start section for engineers (formats, preferred files, and usage tips)対応中かも @faisalnugroho が 140 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
шефオープン
難易度 1/5 1時間未満 初心者へのやさしさ 15/100
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 83/100
-
documentation v3
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
cucumberswift/CucumberSwift#437 ·
メンテナーはふだん 1 日以内に返信
-
area: design documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
eyalgolan/statecraft-israel#883 ·
メンテナーはふだん 1 日以内に返信
-
frontend/README.md is the unchanged, Vite template and doesn't explain how to run the UI対応中かも @Aarav-Singh2007 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
jenkinsci/user-guide-ai-chatbot-plugin#102 · コメント 2 件 ·
メンテナーはふだん 6 日以内に返信