Framing possible contributions
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 20/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
调研方向
先审阅 PR #11 以及本 issue 中引用的讨论，然后比较针对不同文档风格所提议的 checklist 部分。项目就如何构建贡献内容以及将由此产生的指南或 checklist 放置在哪里达成一致后，即视为完成。
由索引模型根据 Issue 内容生成。
描述
In PR #11, @bjnath, @melissawm, and @cooperrc discussed two topics
- Having a template for the tutorials in this repo
- Framing the possible contributions into each document style.
Topic 1 is covered by PR #11 so I wanted to bring up topic 2 in a separate issue.
My thoughts on framing the contributions would be to provide a checklist (maybe it could be included in the PR for a tutorial or how-to). I am using a scientific document as a template because I think many users are using NumPy in scientific applications. Scientific documentation also provides a nice structure to present a problem, propose a solution, and show evidence that it works while providing room for future work.
The checklist would also serve to help review and organize the content. Here is a proposed checklist for review (and general feedback):
Introduction
- Who is the audience
- What will you learn
- What is the problem
- What will you do
Methods
- What do you need
- What will you use
- Are the steps of solution are detailed enough for user
# Results
# Discussion
Wrapping up
- Are there any missing pieces or future work?
- How did NumPy help solve the original problem posed?
# Conclusion
- 主要语言
- 没有语言数据
- 星标
- 673
- 派生
- 229
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
numpy/numpy-tutorials 的其他 Issue
-
bug
难度 1/5 1 小时以内 新手友好度 68/100
numpy/numpy-tutorials#228 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 62/100
numpy/numpy-tutorials#150 · 2 条评论 ·
-
enhancement
难度 3/5 1-2 天 新手友好度 45/100
numpy/numpy-tutorials#305 · 1 个 reaction ·
-
maintenance
难度 4/5 3-5 天 新手友好度 48/100
numpy/numpy-tutorials#283 · 1 个 reaction ·
-
enhancement infrastructure maintenance
难度 4/5 3-5 天 新手友好度 25/100
numpy/numpy-tutorials#280 · 5 条评论 ·
查看 numpy/numpy-tutorials 的全部 Issue
相似的 Issue
-
automated issue report
难度 2/5 1-3 小时 新手友好度 75/100
-
Humanity AI 未关闭
难度 1/5 1 小时以内 新手友好度 90/100
numfocus/project-fundraising#166 ·
-
area:proxy bug security severity:low track:open-source
难度 2/5 1-3 小时 新手友好度 70/100