realpython / realpython/python-guide
Clarification on Sample Repository Structure
オープン
まだ誰も着手していません。
- 主要言語
- Batchfile
- スター
- 29.8k
- フォーク
- 5.9k
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
In Structuring Your Project (/writing/structure/) the section Sample Repository is a little confusing (at least for me).
- Stating that this is the way Kenneth Reitz recommends structuring a project is a little confusing. Is there another way? (I'm sure there are) If so, is Reitz's way the de facto standard or is there another standard out there? (Perhaps links to some other popular structures would be helpful)
- On the same vein as 1 above, in most areas the guide is opinionated but in this section by stating its the way Reitz does it, it becomes very unopinionated and this sticks out. Does this mean that the authors aren't agreed upon Reitz's methodology?
- We haven't talked about setup.py up to this point in the guide. What is it? (https://stackoverflow.com/questions/1471994/what-is-setup-py)
- Here it is suggested we use requirements.txt although earlier we are encouraged to use pipenv and its pipfile (although we are also shown how to use virtualenv directly), this is a bit confusing as there is no mention of a pipfile at all. Might be helpful to expand to include some notes on the pipfile and whether we should include both or one over the other.
- The suggested project structure doesn't include context.py, but this seems to be as much a core part as the rest of the test files - should this be added?
- The section on Makefile is also confusing - there is no reference to Makefile in the initial project structure; when exactly might one use this?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
/writing/structure/ の Sample Repository セクションから始め、setup.py、requirements.txt、Pipfile、virtualenv、context.py、Makefile に関する周辺のガイダンスを読みます。記載されているプロジェクト構成とワークフローを比較し、そのうえで、どの説明やリンクに明確化が必要かを特定します。セクションが推奨事項、代替案、および名前が挙げられている各ファイルの役割を一貫して説明していれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100