DOC: update contributing guide to reflect the preferred practice

オープン
#186 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

現在のコントリビューションガイドとREADMEを読んで、ノートブックに関するプラクティスがどこに記載されているかを確認してください。ノートブックには出力を含めないこと、また.ipynbよりも.mdファイルを推奨することが明記されるようにガイダンスを更新してください。選択したガイドの構成に両方の点が明確に反映されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation infrastructure

Currently missing points:

  • No outputs should be included in the notebooks
  • we do prefer .md files 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?

主要言語
言語のデータがありません
スター
673
フォーク
229
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

numpy/numpy-tutorials のほかの issue

numpy/numpy-tutorials の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。