Update for Carpentries Style

未關閉 適合新手
#179 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
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

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

LibraryCarpentry/lc-python-intro 的其他 Issue

查看 LibraryCarpentry/lc-python-intro 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。