pypa / pypa/packaging.python.org

New tutorials: write section to define and describe "package"

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

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

component: tutorials
主要言語
Python
スター
1.7k
フォーク
1.7k
平均マージ
3日 12時間
マージ済み PR(30日)
4

説明

(For more information about this issue, please see #194).

We need a short section to follow the prerequisites section (see #196) (i.e., as its own file). It should satisfy the following goals:

  • explain what a distribution package is
  • explain how a distribution package differs from import packages and modules
  • use the terminology that the wider Python Packaging User Guide uses, so the terminology is familiar if the reader turns to another part of the guide

I also think it would be helpful if the section could illustrate each point with some kind of example, either a made-up example or a real-world example, if it's not too complicated.

When opening pull requests for this issue, please submit to the develop branch. If you have questions that concern contributing more generally, please use issue #194. Otherwise, feel free to comment with questions or feedback. Thanks!

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

まず、issue で参照されている前提条件のセクションと、Python Packaging User Guide にある distribution packages、import packages、modules のリンクされた用語集エントリを確認します。前提条件の後に独立したセクションファイルが続き、ガイドの用語を使用し、それぞれの概念を区別する明確な例を含んでいれば、作業は完了です。変更を develop branch に提出してください。

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

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
48/100

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

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