DOC: update contributing guide to reflect the preferred practice
オープン
まだ誰も着手していません。
documentation
infrastructure
- 主要言語
- 言語のデータがありません
- スター
- 673
- フォーク
- 229
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Currently missing points:
- No outputs should be included in the notebooks
- we do prefer
.mdfiles as opposed to.ipynb.
Maybe the updated guide should be in a separate file, and keep the absolute newcomer version, that we currently have, in the README?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
現在のコントリビューションガイドとREADMEを読んで、ノートブックに関するプラクティスがどこに記載されているかを確認してください。ノートブックには出力を含めないこと、また.ipynbよりも.mdファイルを推奨することが明記されるようにガイダンスを更新してください。選択したガイドの構成に両方の点が明確に反映されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100