Update for Carpentries Style

オープン 初心者向け
#179 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

レッスンの内容全体に目を通し、「OK!」「interesting」「significant」の出現箇所、エピソード10のイタリック体、「let’s」や「don’t」などの短縮形に注目してください。スタイルレビューに対応するために表現と書式を修正し、その後、レッスン全体で一貫して適用されているか確認してください。このissueでは、具体的なファイルやテストは指定されていません。

索引モデルが issue の本文から書いたものです。

説明

good first issue
How could the content be improved?

Via Carpentries Lab review:

I felt that the use of "OK!" and "This is interesting, ..." to be a bit more colloquialisms and geared towards audiences whose native language is English, especially with the OK. I would remove the use of interesting and significant as that implies a judgement made by the writers and not those doing the lesson who might find something else interesting or significant.

Encapsulate in italics seems a little strange. I would remove the italic (episode 10).

There are contractions used throughout such as let's, don't, or doesn't.

主要言語
HTML
スター
25
フォーク
65
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

LibraryCarpentry/lc-python-intro のほかの issue

LibraryCarpentry/lc-python-intro の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。