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 摘要。