Framing possible contributions
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
まず PR #11 とこの issue で参照されている議論を確認し、その後、異なるドキュメントスタイルに対して提案されているチェックリストのセクションを比較します。プロジェクトが、コントリビューションをどのように構成すべきか、またその結果得られるガイダンスまたはチェックリストをどこに配置するかについて合意すれば完了です。
索引モデルが 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 件 ·
-
maintenance
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
numpy/numpy-tutorials#283 · リアクション 1 件 ·
-
enhancement infrastructure maintenance
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
numpy/numpy-tutorials#280 · コメント 5 件 ·
numpy/numpy-tutorials の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
git/git-scm.com#2207 ·
-
link-check link-check:sphinx-theme
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
qgis/QGIS-Documentation#11275 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
CSCfi/sd-search-api#39 ·
-
sync-en
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100