From f557156ef465a3f67ac520651d57d3b7dfafd1ee Mon Sep 17 00:00:00 2001 From: Hirotaka Mizutani Date: Fri, 17 Jan 2020 12:25:42 +0900 Subject: [PATCH 1/2] docs: update style-guild --- style-guide.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/style-guide.md b/style-guide.md index d9b9097cc..81b5b1395 100644 --- a/style-guide.md +++ b/style-guide.md @@ -123,6 +123,40 @@ React について詳しくない方は、まず[こちらのガイド](https:// - データの変換 ``` +### 半角と全角のスペース + +半角と全角が切り替わる箇所にスペースをいれてください。 + +例: + +✅ 良い: + +```md +もし React について詳しくなければ、まずは[こちらのガイド](https://reactjs.org)をご覧ください。 +``` + +❌ ダメかも: + +```md +もし React について詳しくなければ、まずは[こちらのガイド](https://reactjs.org)をご覧ください。 +``` + +上記の例は、textlint で検知ができるのですが、「``」や「""」で囲まれている場合は、textlint で検知できないため、手動でスペースをいれてください。 + +例: + +✅ 良い: + +```md +ここで、新しく "Contact" ページ用に `src/pages/contact.js` としてページコンポーネントを作成し、ホームページにリンクする必要があります。 +``` + +❌ ダメかも: + +```md +ここで、新しく"Contact"ページ用に`src/pages/contact.js`としてページコンポーネントを作成し、ホームページにリンクする必要があります。 +``` + ## 用語集 頻出する用語は合意を得た上でリストに加えてください。さらに[prh.yml](/prh.yml)にルールを追加することで、CI にチェックを任せることができます。 From 26c51b83814bc40d4ec8c6c5503cd87cccde6c30 Mon Sep 17 00:00:00 2001 From: Hirotaka Mizutani Date: Fri, 17 Jan 2020 12:55:22 +0900 Subject: [PATCH 2/2] Update style-guide.md --- style-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/style-guide.md b/style-guide.md index 81b5b1395..c517ddcfd 100644 --- a/style-guide.md +++ b/style-guide.md @@ -138,7 +138,7 @@ React について詳しくない方は、まず[こちらのガイド](https:// ❌ ダメかも: ```md -もし React について詳しくなければ、まずは[こちらのガイド](https://reactjs.org)をご覧ください。 +もしReactについて詳しくなければ、まずは[こちらのガイド](https://reactjs.org)をご覧ください。 ``` 上記の例は、textlint で検知ができるのですが、「``」や「""」で囲まれている場合は、textlint で検知できないため、手動でスペースをいれてください。