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
- 主要語言
- 沒有語言資料
- 星號
- 679
- 分支
- 229
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 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
-
bug
難度 2/5 1 小時以內 新手友好度 82/100
awslabs/visual-asset-management-system#413 ·
維護者通常 1 天內回覆
-
good first issue hacktoberfest
難度 2/5 半天 新手友好度 70/100
HelpCode-ai/anythingmcp#996 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 88/100
zerocracy/judges-action#2730 ·
維護者通常 8 天內回覆
-
feedback simulation workshop
難度 2/5 1-3 小時 新手友好度 62/100
githubnext/gh-aw-workshop#4417 ·
維護者通常 1 天內回覆
-
documentation Good First Issue hacktoberfest Non-Code
難度 2/5 1-3 小時 新手友好度 88/100
hiero-ledger/hiero-sdk-js#4488 ·
維護者通常 1 天內回覆